Webhook response payload example (expansion enabled)

When a subscription.group.updated 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": "EXECUTED",
    "cotermNextChargeDate": 1741392000000,
    "cotermNextChargeTotal": 30,
    "cotermGroupSize": 2,
    "currency": "USD",
    "account": "abCdE1FGH2Hij3KLMnOpqR",
    "paymentOverdue": {
      "intervalUnit": "week",
      "intervalLength": 1,
      "total": 4,
      "sent": 0
    },
    "cancellationSetting": {
      "cancellation": "AFTER_LAST_NOTIFICATION",
      "intervalUnit": "week",
      "intervalLength": 1
    },
    "subscriptions": [
      {
        "id": "1abc2DE_FGhIjKLm3NoPQR",
        "active": true,
        "state": "active",
        "isSubscriptionEligibleForPauseByBuyer": false,
        "isPauseScheduled": false,
        "changed": 1738950409989,
        "live": false,
        "currency": "USD",
        "account": {
          "id": "abCdE1FGH2Hij3KLMnOpqR",
          "account": "abCdE1FGH2Hij3KLMnOpqR",
          "contact": {
            "first": "Jane",
            "last": "Doe",
            "email": "nkoly@fastspring.com",
            "company": null,
            "phone": "5555555",
            "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"
        },
        "product": "cloud-storage",
        "sku": null,
        "display": "Cloud Storage Service",
        "quantity": 1,
        "adhoc": false,
        "autoRenew": true,
        "price": 10,
        "discount": 0,
        "subtotal": 10,
        "next": 1741392000000,
        "end": null,
        "endValue": null,
        "canceledDate": null,
        "deactivationDate": null,
        "sequence": 1,
        "periods": null,
        "remainingPeriods": null,
        "begin": 1738256122354,
        "intervalUnit": "month",
        "intervalUnitAbbreviation": "mo",
        "intervalLength": 1,
        "nextChargeCurrency": "USD",
        "nextChargeDate": 1741392000000,
        "nextChargePreTax": 9.26,
        "nextChargeTotal": 10,
        "addons": null,
        "fulfillments": {},
        "instructions": [
          {
            "product": "cloud-storage",
            "type": "regular",
            "isNotTrial": true,
            "periodStartDate": 1738195200000,
            "periodEndDate": null,
            "intervalUnit": "month",
            "intervalLength": 1,
            "discountDurationUnit": null,
            "discountDurationLength": null,
            "discountPercent": 0,
            "discountTotal": 0,
            "unitDiscount": 0,
            "price": 10,
            "priceTotal": 10,
            "unitPrice": 10,
            "total": 10,
            "totalWithTaxes": 10,
            "totalWithTaxesDisplay": "$10.00"
          }
        ]
      },
      {
        "id": "2abc2DE_FGhIjKLm3NoPQR",
        "active": true,
        "state": "active",
        "isSubscriptionEligibleForPauseByBuyer": false,
        "isPauseScheduled": false,
        "changed": 1738950409989,
        "live": false,
        "currency": "USD",
        "account": {
          "id": "abCdE1FGH2Hij3KLMnOpqR",
          "account": "abCdE1FGH2Hij3KLMnOpqR",
          "contact": {
            "first": "Jane",
            "last": "Doe",
            "email": "nkoly@fastspring.com",
            "company": null,
            "phone": "5555555",
            "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"
        },
        "product": "data-analytics",
        "sku": null,
        "display": "Data Analytics Service",
        "quantity": 1,
        "adhoc": false,
        "autoRenew": true,
        "price": 10,
        "discount": 0,
        "subtotal": 10,
        "next": 1741392000000,
        "end": null,
        "endValue": null,
        "canceledDate": null,
        "deactivationDate": null,
        "sequence": 1,
        "periods": null,
        "remainingPeriods": null,
        "begin": 1738256076037,
        "intervalUnit": "month",
        "intervalUnitAbbreviation": "mo",
        "intervalLength": 1,
        "nextChargeCurrency": "USD",
        "nextChargeDate": 1741392000000,
        "nextChargePreTax": 9.26,
        "nextChargeTotal": 10,
        "addons": null,
        "fulfillments": {},
        "instructions": [
          {
            "product": "data-analytics",
            "type": "regular",
            "isNotTrial": true,
            "periodStartDate": 1738195200000,
            "periodEndDate": null,
            "intervalUnit": "month",
            "intervalLength": 1,
            "discountDurationUnit": null,
            "discountDurationLength": null,
            "discountPercent": 0,
            "discountTotal": 0,
            "unitDiscount": 0,
            "price": 10,
            "priceTotal": 10,
            "unitPrice": 10,
            "total": 10,
            "totalWithTaxes": 10,
            "totalWithTaxesDisplay": "$10.00"
          }
        ]
      }
    ]
}

Navigate this webhook

The subscription.group.updated webhook payload includes dozens of fields. Use the cards below to jump to a specific section of the property reference.

Cancellation Settings

Payload properties

All fields below are included in the subscription.group.updated 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., `EXECUTED`)
cotermGroupSize	integer	Number of subscriptions in the co-term group
currency	string	Three-letter ISO currency code
Next Charge
cotermNextChargeDate	integer	Next co-term group charge date in milliseconds
cotermNextChargeTotal	number	Total amount for the next co-term group charge
Account (ID)
account	string	FastSpring account ID associated with this co-term group
Payment Overdue
paymentOverdue.intervalUnit	string	Time unit for overdue notifications (e.g., `week`)
paymentOverdue.intervalLength	integer	Number of units before the first overdue notification is sent
paymentOverdue.total	integer	Total number of overdue notifications to send
paymentOverdue.sent	integer	Number of overdue notifications already sent
Cancellation Settings
cancellationSetting.cancellation	string	Cancellation policy timing (e.g., `AFTER_LAST_NOTIFICATION`)
cancellationSetting.intervalUnit	string	Time unit for the cancellation interval
cancellationSetting.intervalLength	integer	Length of the cancellation interval in units
Subscriptions array
subscriptions	array	List of subscriptions in the co-term group
subscriptions.id	string	Subscription ID
subscriptions.active	boolean	Whether the subscription is active
subscriptions.state	string	Current subscription state (e.g., `active`)
subscriptions.isSubscriptionEligibleForPauseByBuyer	boolean	Whether the buyer can pause the subscription
subscriptions.isPauseScheduled	boolean	Whether a pause is scheduled
subscriptions.changed	integer	Last update timestamp in milliseconds
subscriptions.live	boolean	Whether the subscription is in live mode
subscriptions.currency	string	Three-letter ISO currency code
subscriptions.product	string	Product path or identifier
subscriptions.sku	string	SKU of the subscription product when provided
subscriptions.display	string	Customer-facing product display name
subscriptions.quantity	integer	Quantity on the subscription
subscriptions.adhoc	boolean	Whether the subscription is ad-hoc
subscriptions.autoRenew	boolean	Whether auto-renew is enabled
subscriptions.price	number	Unit price for the subscription
subscriptions.discount	number	Discount amount applied
subscriptions.subtotal	number	Subtotal amount before tax
subscriptions.next	integer	Next billing date in milliseconds
subscriptions.end	string	End date, when applicable
subscriptions.endValue	string	End date value mirror, when applicable
subscriptions.canceledDate	string	Cancellation date, when applicable
subscriptions.deactivationDate	string	Deactivation date, when applicable
subscriptions.sequence	integer	Sequence number for the billing period
subscriptions.periods	string	Total number of billing periods when fixed-term
subscriptions.remainingPeriods	string	Remaining number of billing periods
subscriptions.begin	integer	Activation timestamp in milliseconds
subscriptions.intervalUnit	string	Billing interval unit (e.g., `month`)
subscriptions.intervalUnitAbbreviation	string	Abbreviation of the interval unit (e.g., `mo`)
subscriptions.intervalLength	integer	Number of interval units per billing period
Next Charge
subscriptions.nextChargeCurrency	string	Currency of the next charge
subscriptions.nextChargeDate	integer	Next charge date in milliseconds
subscriptions.nextChargePreTax	number	Pre-tax amount for the next charge
subscriptions.nextChargeTotal	number	Total next charge amount
Account
subscriptions.account.id	string	Unique FastSpring account ID
subscriptions.account.account	string	Duplicate of the account ID
subscriptions.account.contact.first	string	Account contact first name
subscriptions.account.contact.last	string	Account contact last name
subscriptions.account.contact.email	string	Account contact email address
subscriptions.account.contact.company	string	Account contact company name when provided
subscriptions.account.contact.phone	string	Account contact phone number
subscriptions.account.contact.subscribed	boolean	Whether the account contact is subscribed
subscriptions.account.address.address line 1	string	Primary street address line
subscriptions.account.address.address line 2	string	Secondary street address line
subscriptions.account.address.city	string	City
subscriptions.account.address.country	string	Two-letter ISO country code
subscriptions.account.address.postal code	string	Postal or ZIP code
subscriptions.account.address.region	string	Region code (e.g., `US-NY`)
subscriptions.account.address.region custom	string	Custom region text when applicable
subscriptions.account.address.company	string	Company associated with the address
subscriptions.account.language	string	Preferred language (two-letter ISO code)
subscriptions.account.country	string	Two-letter ISO country code
subscriptions.account.lookup.global	string	Globally unique public ID for lookup
subscriptions.account.url	string	Customer-facing account management URL
Add-ons
subscriptions.addons	array	Array of add-on items when present
subscriptions.fulfillments	object	Fulfillment details (object may be empty)
Instructions
subscriptions.instructions	array	Pricing and timing instructions for each subscription period
subscriptions.instructions.product	string	Product path associated with the instruction
subscriptions.instructions.type	string	Instruction type (e.g., `regular`)
subscriptions.instructions.isNotTrial	boolean	Whether the instruction is not a trial
subscriptions.instructions.periodStartDate	integer	Start date of the instruction period in milliseconds
subscriptions.instructions.periodEndDate	integer	End date of the instruction period when present
subscriptions.instructions.intervalUnit	string	Billing interval unit for the instruction
subscriptions.instructions.intervalLength	integer	Number of interval units for the instruction period
subscriptions.instructions.discountDurationUnit	string	Unit for remaining discount duration, when applicable
subscriptions.instructions.discountDurationLength	integer	Length of remaining discount duration, when applicable
subscriptions.instructions.discountPercent	number	Discount percentage
subscriptions.instructions.discountTotal	number	Total discount amount
subscriptions.instructions.unitDiscount	number	Per-unit discount
subscriptions.instructions.price	number	Unit price
subscriptions.instructions.priceTotal	number	Total price for the instruction
subscriptions.instructions.unitPrice	number	Unit price before taxes
subscriptions.instructions.total	number	Total amount before taxes
subscriptions.instructions.totalWithTaxes	number	Total amount including taxes
subscriptions.instructions.totalWithTaxesDisplay	string	Formatted total including taxes