Event payload example and property overview for subscription.group.deactivated
Webhook response payload example (expansion enabled)
When a subscription.group.deactivated event is triggered, the webhook sends the following JSON payload:
{
"cotermGroupId": "aB1c2deFGhIjKL3mn-opqR",
"cotermGroupDisplayName": "Tech Services Monthly Plan",
"cotermGroupPeriodStartDate": 1754044800000,
"cotermGroupPeriodEndDate": 1756646400000,
"cotermGroupPrimarySubscription": "1abc2DE_FGhIjKLm3NoPQR",
"cotermGroupStatus": "DUNNING",
"cotermGroupOrderId": "aBCDE12fGH3iJkL4mNOpq",
"cotermNextChargeDate": 1740441600000,
"cotermNextChargeTotal": 49.9,
"cotermGroupSize": 2,
"currency": "USD",
"account": {
"id": "abCdE1FGH2Hij3KLMnOpqR",
"account": "abCdE1FGH2Hij3KLMnOpqR",
"contact": {
"first": "Jane",
"last": "Doe",
"email": "[email protected]",
"company": "Company Inc.",
"phone": "8001234567",
"subscribed": true
},
"address": {
"address line 1": "123 Business Rd",
"address line 2": "Floor 4",
"city": "Metropolis",
"country": "US",
"postal code": "12345",
"region": "US-NY",
"region custom": null,
"company": "Company Inc."
},
"language": "en",
"country": "US",
"lookup": {
"global": "lookup-001"
},
"url": "https://company.onfastspring.com/account"
},
"subscriptions": [
"1abc2DE_FGhIjKLm3NoPQR",
"2abc2DE_FGhIjKLm3NoPQR"
]
}
Navigate this webhook
The subscription.group.deactivated webhook payload includes dozens of fields. Use the cards below to jump to a specific section of the property reference.
Payload properties
All fields below are included in the subscription.group.deactivated webhook payload. Fields are grouped into categories for easier navigation.
| Name | Type | Description |
|---|---|---|
| Co-term Group | ||
| cotermGroupId | string | Unique identifier for the co-term group |
| cotermGroupDisplayName | string | Display name of the co-term group |
| cotermGroupPeriodStartDate | integer | Start of the current co-term period in milliseconds since epoch |
| cotermGroupPeriodEndDate | integer | End of the current co-term period in milliseconds since epoch |
| cotermGroupPrimarySubscription | string | ID of the primary subscription in the co-term group |
| cotermGroupStatus | string | Status of the co-term group (e.g., DUNNING) |
| cotermGroupOrderId | string | Order ID associated with the co-term group |
| cotermNextChargeDate | integer | Next co-term group charge date in milliseconds |
| cotermNextChargeTotal | number | Total amount for the next group charge |
| cotermGroupSize | integer | Number of subscriptions in the co-term group |
| currency | string | Three-letter ISO currency code |
| Account object | ||
| account.id | string | Unique FastSpring account ID |
| account.account | string | Duplicate of the account ID for compatibility |
| account.contact.first | string | Account contact first name |
| account.contact.last | string | Account contact last name |
| account.contact.email | string | Account contact email address |
| account.contact.company | string | Account contact company name |
| account.contact.phone | string | Account contact phone number |
| account.contact.subscribed | boolean | Whether the account contact is subscribed |
| account.address.address line 1 | string | Primary street address line |
| account.address.address line 2 | string | Secondary street address line |
| account.address.city | string | City |
| account.address.country | string | Two-letter ISO country code |
| account.address.postal code | string | Postal or ZIP code |
| account.address.region | string | Region code (e.g., US-NY) |
| account.address.region custom | null|string | Custom region text when applicable |
| account.address.company | string | Company associated with the address |
| account.language | string | Preferred language (two-letter ISO code) |
| account.country | string | Two-letter ISO country code |
| account.lookup.global | string | Globally unique public ID for lookup |
| account.url | string | Customer-facing account management URL |
| Subscriptions array | ||
| subscriptions | array | List of subscription IDs that were part of the deactivated co-term group |