Co-term Group Deactivated

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.

NameTypeDescription
Co-term Group
cotermGroupIdstringUnique identifier for the co-term group
cotermGroupDisplayNamestringDisplay name of the co-term group
cotermGroupPeriodStartDateintegerStart of the current co-term period in milliseconds since epoch
cotermGroupPeriodEndDateintegerEnd of the current co-term period in milliseconds since epoch
cotermGroupPrimarySubscriptionstringID of the primary subscription in the co-term group
cotermGroupStatusstringStatus of the co-term group (e.g., DUNNING)
cotermGroupOrderIdstringOrder ID associated with the co-term group
cotermNextChargeDateintegerNext co-term group charge date in milliseconds
cotermNextChargeTotalnumberTotal amount for the next group charge
cotermGroupSizeintegerNumber of subscriptions in the co-term group
currencystringThree-letter ISO currency code
Account object
account.idstringUnique FastSpring account ID
account.accountstringDuplicate of the account ID for compatibility
account.contact.firststringAccount contact first name
account.contact.laststringAccount contact last name
account.contact.emailstringAccount contact email address
account.contact.companystringAccount contact company name
account.contact.phonestringAccount contact phone number
account.contact.subscribedbooleanWhether the account contact is subscribed
account.address.address line 1stringPrimary street address line
account.address.address line 2stringSecondary street address line
account.address.citystringCity
account.address.countrystringTwo-letter ISO country code
account.address.postal codestringPostal or ZIP code
account.address.regionstringRegion code (e.g., US-NY)
account.address.region customnull|stringCustom region text when applicable
account.address.companystringCompany associated with the address
account.languagestringPreferred language (two-letter ISO code)
account.countrystringTwo-letter ISO country code
account.lookup.globalstringGlobally unique public ID for lookup
account.urlstringCustomer-facing account management URL
Subscriptions array
subscriptionsarrayList of subscription IDs that were part of the deactivated co-term group