Pauses

Endpoint can be called by:

GET /contractChanges/{id}?includePauses=All&includeContract=true

Parameter values for the includePauses:

Parameter value	Description
`All`	Contains unchanged and changed pauses
`Changed`	Contains only changed pauses
`None`	(Default) Contains no pauses

Example response for a component subscription change

{
    "Id": "647db9e7715e7089c55b7683",
    "Type": "Resume",
    "Timestamp": "2023-06-05T10:33:11.2860000Z",
    "ContractId": "647dae8f715e7089c55b75c1",
    "ChangeDate": "2023-06-05T10:33:09.0440000Z",
    "NewPlanVariantId": "63e62a0d9864a09b6e4b2048",
    "NewPlanId": "63e62a0d9864a09b6e4b2045",
    "Contract": {
        "Id": "647dae8f715e7089c55b75c1",
        "Before": {
            "CurrentPhase": { ... },
            "Phases": [ ... ],
            "CurrentPause": {
                "StartDate": "2023-06-05T10:16:56.1100000Z",
                "EndDate": "2023-06-05T10:33:09.0440000Z"
            }
        },
        "After": {
            "CurrentPhase": { ... },
            "Phases": [ ... ],
        }
    },
    "Pauses": [
        {
            "Id": "647db61c715e7089c55b7663",
            "Before": {
                "Id": "647db61c715e7089c55b7663",
                "StartDate": "2023-06-05T10:16:56.1100000Z"
            },
            "After": {
                "Id": "647db61c715e7089c55b7663",
                "StartDate": "2023-06-05T10:16:56.1100000Z",
                "EndDate": "2023-06-05T10:33:09.0440000Z"
            }
        }
    ]
}

Response object contains

A complete list of pauses as a list with Before and After states,
The active pause will always be displayed in the contract in node CurrentPause in the Before and After (as pauses might have an effect on the current phase).

T1 Pause creation

Example 35. ContractChanged Webhook

{  
    "ContractId": "647daec7715e7089c55b75e6",  
    "CustomerId": "647daec7715e7089c55b75e2",  
    "ExternalCustomerId": "774252",  
    "ContractChangeId": "647db578715e7089c55b7622",  
    "ContractChangeType": "Pause",
    "Event": "ContractChanged",  
    "EntityId": "63b2d4405b49105c19fa7714"
}

Example 36. Contract Change Details Webhook

{    
    "Id": "647db578715e7089c55b7622",    
    "Type": "Pause",    
    "Timestamp": "2023-06-05T10:14:16.8530000Z",    
    "ContractId": "647daec7715e7089c55b75e6",    
    "ChangeDate": "2023-07-05T09:46:42.7630000Z",    
    "NewPlanVariantId": "63e62a0d9864a09b6e4b2048",    
    "NewPlanId": "63e62a0d9864a09b6e4b2045",    
    "Contract": {  
      "Id": "647daec7715e7089c55b75e6",
      "Before": {
            "CurrentPhase": { 
               "Type": "Normal",                
               "StartDate": "2023-06-05T09:46:42.7630000Z",                
               "PlanVariantId": "63e62a0d9864a09b6e4b2048",
               "PlanId": "63e62a0d9864a09b6e4b2045", 
               "Quantity": 1,
               "InheritStartDate": false  
           },      
           "Phases": [  
              {               
                 "Type": "Normal",
                 "StartDate": "2023-06-05T09:46:42.7630000Z",
                 "PlanVariantId": "63e62a0d9864a09b6e4b2048",     
                 "PlanId": "63e62a0d9864a09b6e4b2045",
                 "Quantity": 1,
                 "InheritStartDate": false
              }
           ]
}

...

"After": {
        "CurrentPhase": {
             "Type": "Normal",
             "StartDate": "2023-06-05T09:46:42.7630000Z",
             "PlanVariantId": "63e62a0d9864a09b6e4b2048",
             "PlanId": "63e62a0d9864a09b6e4b2045",
             "Quantity": 1,
             "InheritStartDate": false  
        }, 
        "Phases": [
            {     
               "Type": "Normal", 
               "StartDate": "2023-06-05T09:46:42.7630000Z",
               "PlanVariantId": "63e62a0d9864a09b6e4b2048",
               "PlanId": "63e62a0d9864a09b6e4b2045",
               "Quantity": 1, 
               "InheritStartDate": false 
            }
        ]
     }
  },
  "Pauses": [  
      {          
          "Id": "647db578715e7089c55b761e",   
          "After": { 
               "Id": "647db578715e7089c55b761e",      
               "StartDate": "2023-07-05T09:46:42.7630000Z" 
          } 
       }
    ]
}

T2 Pause start

Example 37. ContractChanged Webhook

{  
    "ContractId": "647daec7715e7089c55b75e6",  
    "CustomerId": "647daec7715e7089c55b75e2",  
    "ExternalCustomerId": "774252",  
    "ContractChangeId": "647db61c715e7089c55b7673",  
    "ContractChangeType": "Timebased",
    "Event": "ContractChanged",  
    "EntityId": "63b2d4405b49105c19fa7714"
}

Example 38. Contract Change Details Webhook

{    
    "Id": "647db61c715e7089c55b7673",    
    "Type": "Timebased",    
    "Timestamp": "2023-07-05T09:46:42.7630000Z",    
    "ContractId": "647daec7715e7089c55b75e6",       
    "NewPlanVariantId": "63e62a0d9864a09b6e4b2048",    
    "NewPlanId": "63e62a0d9864a09b6e4b2045",    
    "Contract": {  
      "Id": "647daec7715e7089c55b75e6",
      "Before": {
            "CurrentPhase": { 
               "Type": "Normal",                
               "StartDate": "2023-06-05T09:46:42.7630000Z",                
               "PlanVariantId": "63e62a0d9864a09b6e4b2048",
               "PlanId": "63e62a0d9864a09b6e4b2045", 
               "Quantity": 1,
               "InheritStartDate": false  
           },      
           "Phases": [  
              {               
                 "Type": "Normal",
                 "StartDate": "2023-06-05T09:46:42.7630000Z",
                 "PlanVariantId": "63e62a0d9864a09b6e4b2048",     
                 "PlanId": "63e62a0d9864a09b6e4b2045",
                 "Quantity": 1,
                 "InheritStartDate": false
              }
           ]
}

...

"After": {
        "CurrentPhase": {
             "Type": "Normal",
             "StartDate": "2023-06-05T09:46:42.7630000Z",
             "PlanVariantId": "63e62a0d9864a09b6e4b2048",
             "PlanId": "63e62a0d9864a09b6e4b2045",
             "Quantity": 1,
             "InheritStartDate": false  
        }, 
        "Phases": [
            {     
               "Type": "Normal", 
               "StartDate": "2023-06-05T09:46:42.7630000Z",
               "PlanVariantId": "63e62a0d9864a09b6e4b2048",
               "PlanId": "63e62a0d9864a09b6e4b2045",
               "Quantity": 1, 
               "InheritStartDate": false 
            }
        ],
        "CurrentPause": {    
            "StartDate": "2023-07-05T09:46:42.7630000Z"  
        }
     }
  },
  "Pauses": [  
      {          
          "Id": "647db578715e7089c55b761e",   
          "Before": { 
               "Id": "647db578715e7089c55b761e",      
               "StartDate": "2023-07-05T09:46:42.7630000Z" 
          },
          "After": { 
               "Id": "647db578715e7089c55b761e",      
               "StartDate": "2023-07-05T09:46:42.7630000Z" 
          }  
       }
    ]
}

T3 Pause end set

Example 39. ContractChanged Webhook

{  
    "ContractId": "647daec7715e7089c55b75e6",  
    "CustomerId": "647daec7715e7089c55b75e2",  
    "ExternalCustomerId": "774252",  
    "ContractChangeId": "647db80d9209eaa79d95ff8b",  
    "ContractChangeType": "Resume",
    "Event": "ContractChanged",  
    "EntityId": "63b2d4405b49105c19fa7714"
}

Example 40. Contract Change Details Webhook

{    
    "Id": "647db80d9209eaa79d95ff8b",    
    "Type": "Resume",    
    "Timestamp": "2023-07-08T10:12:38.1230000Z",    
    "ContractId": "647daec7715e7089c55b75e6",       
    "NewPlanVariantId": "63e62a0d9864a09b6e4b2048",    
    "NewPlanId": "63e62a0d9864a09b6e4b2045",
    "ChangeDate": "2023-08-05T09:46:42.7630000Z",    
    "Contract": {  
      "Id": "647daec7715e7089c55b75e6",
      "Before": {
            "CurrentPhase": { 
               "Type": "Normal",                
               "StartDate": "2023-06-05T09:46:42.7630000Z",                
               "PlanVariantId": "63e62a0d9864a09b6e4b2048",
               "PlanId": "63e62a0d9864a09b6e4b2045", 
               "Quantity": 1,
               "InheritStartDate": false  
           },      
           "Phases": [  
              {               
                 "Type": "Normal",
                 "StartDate": "2023-06-05T09:46:42.7630000Z",
                 "PlanVariantId": "63e62a0d9864a09b6e4b2048",     
                 "PlanId": "63e62a0d9864a09b6e4b2045",
                 "Quantity": 1,
                 "InheritStartDate": false
              }
           ],
          "CurrentPause": {    
            "StartDate": "2023-07-05T09:46:42.7630000Z"  
        }
},

...

"After": {
        "CurrentPhase": {
             "Type": "Normal",
             "StartDate": "2023-06-05T09:46:42.7630000Z",
             "PlanVariantId": "63e62a0d9864a09b6e4b2048",
             "PlanId": "63e62a0d9864a09b6e4b2045",
             "Quantity": 1,
             "InheritStartDate": false  
        }, 
        "Phases": [
            {     
               "Type": "Normal", 
               "StartDate": "2023-06-05T09:46:42.7630000Z",
               "PlanVariantId": "63e62a0d9864a09b6e4b2048",
               "PlanId": "63e62a0d9864a09b6e4b2045",
               "Quantity": 1, 
               "InheritStartDate": false 
            }
        ],
        "CurrentPause": {    
            "StartDate": "2023-07-05T09:46:42.7630000Z",  
            "EndDate": "2023-08-05T09:46:42.7630000Z"
        }
     }
  },
  "Pauses": [  
      {          
          "Id": "647db578715e7089c55b761e",   
          "Before": { 
               "Id": "647db578715e7089c55b761e",      
               "StartDate": "2023-07-05T09:46:42.7630000Z" 
          },
          "After": { 
               "Id": "647db578715e7089c55b761e",      
              "StartDate": "2023-07-05T09:46:42.7630000Z",
               "EndDate": "2023-08-05T09:46:42.7630000Z" 
          }  
       }
    ]
}

T4 Pause ends

Example 41. ContractChanged Webhook

{  
    "ContractId": "647daec7715e7089c55b75e6",  
    "CustomerId": "647daec7715e7089c55b75e2",  
    "ExternalCustomerId": "774252",  
    "ContractChangeId": "647db9596acf7a5c79436e87",  
    "ContractChangeType": "Timebased",
    "EntityId": "63b2d4405b49105c19fa7714"
}

Example 42. Contract Change Details Webhook

{    
    "Id": "647db9596acf7a5c79436e87",    
    "Type": "Resume",    
    "Timestamp": "2023-07-08T10:12:38.1230000Z",    
    "ContractId": "647daec7715e7089c55b75e6",       
    "NewPlanVariantId": "63e62a0d9864a09b6e4b2048",    
    "NewPlanId": "63e62a0d9864a09b6e4b2045", 
    "Contract": {  
      "Id": "647daec7715e7089c55b75e6",
      "Before": {
            "CurrentPhase": { 
               "Type": "Normal",                
               "StartDate": "2023-06-05T09:46:42.7630000Z",                
               "PlanVariantId": "63e62a0d9864a09b6e4b2048",
               "PlanId": "63e62a0d9864a09b6e4b2045", 
               "Quantity": 1,
               "InheritStartDate": false  
           },      
           "Phases": [  
              {               
                 "Type": "Normal",
                 "StartDate": "2023-06-05T09:46:42.7630000Z",
                 "PlanVariantId": "63e62a0d9864a09b6e4b2048",     
                 "PlanId": "63e62a0d9864a09b6e4b2045",
                 "Quantity": 1,
                 "InheritStartDate": false
              }
           ],
          "CurrentPause": {    
            "StartDate": "2023-07-05T09:46:42.7630000Z",
            "EndDate": "2023-08-05T09:46:42.7630000Z"  
        }
},

...

"After": {
        "CurrentPhase": {
             "Type": "Normal",
             "StartDate": "2023-06-05T09:46:42.7630000Z",
             "PlanVariantId": "63e62a0d9864a09b6e4b2048",
             "PlanId": "63e62a0d9864a09b6e4b2045",
             "Quantity": 1,
             "InheritStartDate": false  
        }, 
        "Phases": [
            {     
               "Type": "Normal", 
               "StartDate": "2023-06-05T09:46:42.7630000Z",
               "PlanVariantId": "63e62a0d9864a09b6e4b2048",
               "PlanId": "63e62a0d9864a09b6e4b2045",
               "Quantity": 1, 
               "InheritStartDate": false 
            }
        ],
     }
  },
  "Pauses": [  
      {          
          "Id": "647db578715e7089c55b761e",   
          "Before": { 
               "Id": "647db578715e7089c55b761e",      
               "StartDate": "2023-07-05T09:46:42.7630000Z" 
          },
          "After": { 
               "Id": "647db578715e7089c55b761e",      
              "StartDate": "2023-07-05T09:46:42.7630000Z",
               "EndDate": "2023-08-05T09:46:42.7630000Z" 
          }  
       }
    ]
}

In this section:

Welcome to our Dev Docs!