- Welcome to our Dev Docs!
- Use Cases
- Contract Changes
- Contract with a trial which starts immediately
Contract with a trial which starts immediately
Example 1. ContractCreated Webhook
{
"ContractId": "645bb235de464796b7545992",
"CustomerId": "645bb235de464796b754598e",
"ExternalCustomerId": "906260",
"ContractChangeId": "645bb235de464796b754599c",
"Event": "ContractCreated",
"EntityId": "63b2d4405b49105c19fa7714"
}Example 2. ContractChanged Webhook
{
"ContractId": "645bb235de464796b7545992",
"CustomerId": "645bb235de464796b754598e",
"ExternalCustomerId": "906260",
"ContractChangeId": "645bb235de464796b754599c",
"ContractChangeType": "Signup",
"Event": "ContractChanged",
"EntityId": "63b2d4405b49105c19fa7714"
}Example 3. Contract Change Details Webhook
{
"Id": "645bb235de464796b754599c",
"Type": "Signup",
"Timestamp": "2023-04-10T15:04:17.1690000Z",
"OrderId": "645bb235b3636b2f8c1d2d12",
"ContractId": "645bb235de464796b7545992",
"ChangeDate": "2023-04-10T15:04:17.1690000Z",
"NewPlanVariantId": "64478300c37cfa946c6d6140",
"NewPlanId": "644782f0c37cfa946c6d6135",
"Contract": {
"Id": "645bb235de464796b7545992",
"After": {
"CurrentPhase": {
"Type": "Trial",
"StartDate": "2023-04-10T15:04:17.1690000Z",
"PlanVariantId": "64478300c37cfa946c6d6140",
"PlanId": "644782f0c37cfa946c6d6135",
"Quantity": 1,
"InheritStartDate": false
},
"Phases": [
{
"Type": "Trial",
"StartDate": "2023-04-10T15:04:17.1690000Z",
"PlanVariantId": "64478300c37cfa946c6d6140",
"PlanId": "644782f0c37cfa946c6d6135",
"Quantity": 1,
"InheritStartDate": false
},
{
"Type": "Normal",
"StartDate": "2023-05-10T15:04:17.1690000Z",
"PlanVariantId": "64478300c37cfa946c6d6140",
"PlanId": "644782f0c37cfa946c6d6135",
"Quantity": 1,
"InheritStartDate": false
}
]
}
}
}
Example 4. ContractChanged Webhook
{
"ContractId": "645bb235de464796b7545992",
"CustomerId": "645bb235de464796b754598e",
"ExternalCustomerId": "906260",
"ContractChangeId": "645bb235de464796b754599c",
"Event": "ContractCreated",
"EntityId": "63b2d4405b49105c19fa7714"
}Example 5. Contract Change Details Webhook
{
"Id": "645bb235de464796b754599c",
"Type": "Timebased",
"Timestamp": "2023-04-10T15:04:17.1690000Z",
"ContractId": "645bb235de464796b7545992",
"Contract": {
"Id": "645bb235de464796b7545992",
"Before": {
"CurrentPhase": {
"Type": "Trial",
"StartDate": "2023-04-10T15:04:17.1690000Z",
"PlanVariantId": "64478300c37cfa946c6d6140",
"PlanId": "644782f0c37cfa946c6d6135",
"Quantity": 1,
"InheritStartDate": false
},
"Phases": [
{
"Type": "Trial",
"StartDate": "2023-04-10T15:04:17.1690000Z",
"PlanVariantId": "64478300c37cfa946c6d6140",
"PlanId": "644782f0c37cfa946c6d6135",
"Quantity": 1,
"InheritStartDate": false
},
{
"Type": "Normal",
"StartDate": "2023-05-10T15:04:17.1690000Z",
"PlanVariantId": "64478300c37cfa946c6d6140",
"PlanId": "644782f0c37cfa946c6d6135",
"Quantity": 1,
"InheritStartDate": false
}
]
}
...
{
"After": {
"CurrentPhase": {
"Type": "Normal",
"StartDate": "2023-05-10T15:04:17.1690000Z",
"PlanVariantId": "64478300c37cfa946c6d6140",
"PlanId": "644782f0c37cfa946c6d6135",
"Quantity": 1,
"InheritStartDate": false
},
"Phases": [
{
"Type": "Trial",
"StartDate": "2023-04-10T15:04:17.1690000Z",
"PlanVariantId": "64478300c37cfa946c6d6140",
"PlanId": "644782f0c37cfa946c6d6135",
"Quantity": 1,
"InheritStartDate": false
},
{
"Type": "Normal",
"StartDate": "2023-05-10T15:04:17.1690000Z",
"PlanVariantId": "64478300c37cfa946c6d6140",
"PlanId": "644782f0c37cfa946c6d6135",
"Quantity": 1,
"InheritStartDate": false
}
]
},In this section: