Co-term Group Created

Event payload example and property overview for subscription.group.created

Webhook response payload example (expansion enabled)

When a subscription.group.created event is triggered, the webhook sends the following JSON payload:

{
  "cotermGroupId": "aB1c2deFGhIjKL3mn-opqR",
  "cotermGroupDisplayName": "Tech Services Monthly Plan",
  "cotermGroupPeriodStartDate": 1754044800000,
  "cotermGroupPeriodEndDate": 1756646400000,
  "cotermGroupPrimarySubscription": "sub-001",
  "cotermGroupStatus": "EXECUTED",
  "cotermGroupOrderId": "aBCDE12fGH3iJkL4mNOpq",
  "cotermGroupOrderReference": "ABC123456-7891-01112",
  "cotermNextChargeDate": 1756646400000,
  "cotermNextChargeTotal": 199.95,
  "cotermNextChargeTotalDisplay": "$199.95",
  "cotermGroupSize": 2,
  "currency": "USD",
  "changed": 1753526400000,
  "changedValue": 1753526400000,
  "changedInSeconds": 1753526400,
  "changedDisplay": "07/25/25",
  "changedDisplayISO8601": "2025-07-25",
  "nextChargeDate": 1756646400000,
  "nextChargeDateValue": 1756646400000,
  "nextChargeDateInSeconds": 1756646400,
  "nextChargeDateDisplay": "08/31/25",
  "nextChargeDateDisplayISO8601": "2025-08-31",
  "paymentOverdue": {
    "intervalUnit": "week",
    "intervalLength": 1,
    "total": 2,
    "sent": 0
  },
  "cancellationSetting": {
    "cancellation": "AFTER_LAST_NOTIFICATION",
    "intervalUnit": "week",
    "intervalLength": 1
  },
  "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": [
    {
      "id": "1abc2DE_FGhIjKLm3NoPQR",
      "active": true,
      "state": "active",
      "isSubscriptionEligibleForPauseByBuyer": false,
      "isPauseScheduled": false,
      "live": false,
      "currency": "USD",
      "product": "cloud-storage",
      "sku": "SKU-CS-101",
      "display": "Cloud Storage Service",
      "quantity": 1,
      "adhoc": false,
      "autoRenew": true,
      "price": 49.99,
      "discount": 0,
      "subtotal": 49.99,
      "end": null,
      "canceledDate": null,
      "deactivationDate": null,
      "sequence": 1,
      "periods": null,
      "remainingPeriods": null,
      "begin": 1754044800000,
      "intervalUnit": "month",
      "intervalUnitAbbreviation": "mo",
      "intervalLength": 1,
      "intervalLengthGtOne": false,
      "nextChargeCurrency": "USD",
      "nextChargeDate": 1756646400000,
      "nextChargePreTax": 44.99,
      "nextChargeTotal": 49.99,
      "taxExemptionData": null,
      "addons": [
        {
          "product": "data-backup",
          "sku": "SKU-DB-201",
          "display": "Data Backup",
          "quantity": 1,
          "price": 9.99,
          "discount": 0,
          "subtotal": 9.99,
          "subtotalDisplay": "$9.99",
          "discounts": []
        }
      ],
      "discounts": null,
      "fulfillments": {},
      "instructions": [
        {
          "product": "cloud-storage",
          "type": "regular",
          "periodStartDate": 1754044800000,
          "periodEndDate": null,
          "intervalUnit": "month",
          "intervalLength": 1,
          "discountDurationUnit": null,
          "discountDurationLength": null,
          "discountPercent": 0,
          "discountTotal": 0,
          "unitDiscount": 0,
          "price": 49.99,
          "priceTotal": 49.99,
          "unitPrice": 49.99,
          "total": 49.99,
          "totalWithTaxes": 49.99,
          "totalWithTaxesDisplay": "$49.99",
          "isNotTrial": true
        }
      ]
    },
    {
      "id": "2abc2DE_FGhIjKLm3NoPQR",
      "active": true,
      "state": "active",
      "isSubscriptionEligibleForPauseByBuyer": false,
      "isPauseScheduled": false,
      "live": false,
      "currency": "USD",
      "product": "data-analytics",
      "sku": "SKU-DA-102",
      "display": "Data Analytics Service",
      "quantity": 1,
      "adhoc": false,
      "autoRenew": true,
      "price": 79.99,
      "discount": 0,
      "subtotal": 79.99,
      "end": null,
      "canceledDate": null,
      "deactivationDate": null,
      "sequence": 1,
      "periods": null,
      "remainingPeriods": null,
      "begin": 1754044800000,
      "intervalUnit": "month",
      "intervalUnitAbbreviation": "mo",
      "intervalLength": 1,
      "intervalLengthGtOne": false,
      "nextChargeCurrency": "USD",
      "nextChargeDate": 1756646400000,
      "nextChargePreTax": 74.99,
      "nextChargeTotal": 79.99,
      "taxExemptionData": null,
      "addons": [
        {
          "product": "extended-support",
          "sku": "SKU-ES-202",
          "display": "Extended Support",
          "quantity": 1,
          "price": 14.99,
          "discount": 0,
          "subtotal": 14.99,
          "subtotalDisplay": "$14.99",
          "discounts": []
        }
      ],
      "discounts": null,
      "fulfillments": {},
      "instructions": [
        {
          "product": "data-analytics",
          "type": "regular",
          "periodStartDate": 1754044800000,
          "periodEndDate": null,
          "intervalUnit": "month",
          "intervalLength": 1,
          "discountDurationUnit": null,
          "discountDurationLength": null,
          "discountPercent": 0,
          "discountTotal": 0,
          "unitDiscount": 0,
          "price": 79.99,
          "priceTotal": 79.99,
          "unitPrice": 79.99,
          "total": 79.99,
          "totalWithTaxes": 79.99,
          "totalWithTaxesDisplay": "$79.99",
          "isNotTrial": true
        }
      ]
    }
  ]
}

Navigate this webhook

The subscription.group.created 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.created 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., EXECUTED)
cotermGroupOrderIdstringOrder ID associated with the co-term group
cotermGroupOrderReferencestringOrder reference for the co-term group
cotermNextChargeDateintegerNext charge date for the co-term group in milliseconds since epoch
cotermNextChargeTotalnumberTotal amount for the next group charge
cotermNextChargeTotalDisplaystringFormatted next group charge total
cotermGroupSizeintegerNumber of subscriptions in the co-term group
currencystringThree-letter ISO currency code
Changed Timestamps
changedintegerLast update timestamp in milliseconds
changedValueintegerDuplicate of changed (milliseconds)
changedInSecondsintegerLast update timestamp in seconds
changedDisplaystringUser-friendly display date of the last update
changedDisplayISO8601stringISO 8601 date of the last update
Next Charge
nextChargeDateintegerNext charge date in milliseconds
nextChargeDateValueintegerDuplicate of nextChargeDate (milliseconds)
nextChargeDateInSecondsintegerNext charge date in seconds
nextChargeDateDisplaystringUser-friendly next charge date
nextChargeDateDisplayISO8601stringISO 8601 formatted next charge date
Payment Overdue
paymentOverdue.intervalUnitstringTime unit for overdue notifications (e.g., week)
paymentOverdue.intervalLengthintegerNumber of units before the first overdue notification is sent
paymentOverdue.totalintegerTotal number of overdue notifications to send
paymentOverdue.sentintegerNumber of overdue notifications already sent
Cancellation Settings
cancellationSetting.cancellationstringCancellation policy timing (e.g., AFTER_LAST_NOTIFICATION)
cancellationSetting.intervalUnitstringTime unit for the cancellation interval
cancellationSetting.intervalLengthintegerLength of the cancellation interval in units
Account object
accountobjectAccount object containing customer details
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 customstring|nullCustom 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 subscriptions created in the co-term group
subscriptions.idstringSubscription ID
subscriptions.activebooleanWhether the subscription is active
subscriptions.statestringCurrent subscription state (e.g., active)
subscriptions.isSubscriptionEligibleForPauseByBuyerbooleanWhether the buyer can pause the subscription
subscriptions.isPauseScheduledbooleanWhether a pause is scheduled
subscriptions.livebooleanWhether the subscription is in live mode
subscriptions.currencystringThree-letter ISO currency code
subscriptions.productstringProduct path or identifier
subscriptions.skustringSKU of the subscription product
subscriptions.displaystringCustomer-facing product display name
subscriptions.quantityintegerQuantity on the subscription
subscriptions.adhocbooleanWhether the subscription is ad-hoc
subscriptions.autoRenewbooleanWhether auto-renew is enabled
subscriptions.pricenumberUnit price for the subscription
subscriptions.discountnumberDiscount amount applied
subscriptions.subtotalnumberSubtotal amount before tax
subscriptions.endnull|stringEnd date, when applicable
subscriptions.canceledDatenull|stringCancellation date, when applicable
subscriptions.deactivationDatenull|stringDeactivation date, when applicable
subscriptions.sequenceintegerSequence number for the billing period
subscriptions.periodsnull|stringTotal number of billing periods when fixed-term
subscriptions.remainingPeriodsnull|stringRemaining number of billing periods
subscriptions.beginintegerActivation timestamp in milliseconds
subscriptions.intervalUnitstringBilling interval unit (e.g., month)
subscriptions.intervalUnitAbbreviationstringAbbreviation of the interval unit (e.g., mo)
subscriptions.intervalLengthintegerNumber of interval units per billing period
subscriptions.intervalLengthGtOnebooleanWhether the interval length is greater than one
subscriptions.nextChargeCurrencystringCurrency of the next charge
subscriptions.nextChargeDateintegerNext charge date in milliseconds
subscriptions.nextChargePreTaxnumberPre-tax amount for the next charge
subscriptions.nextChargeTotalnumberTotal next charge amount
subscriptions.taxExemptionDatanull|stringTax exemption details when applicable
subscriptions.addonsarray|nullArray of add-on items when present
subscriptions.discountsnull|arrayArray of applied discount objects when present
subscriptions.fulfillmentsobjectFulfillment details (object may be empty)
Add-ons
subscriptions.addons.productstringProduct path for the add-on
subscriptions.addons.skustringSKU for the add-on
subscriptions.addons.displaystringAdd-on display name
subscriptions.addons.quantityintegerAdd-on quantity
subscriptions.addons.pricenumberUnit price for the add-on
subscriptions.addons.discountnumberDiscount amount applied to the add-on
subscriptions.addons.subtotalnumberSubtotal amount for the add-on
subscriptions.addons.subtotalDisplaystringFormatted add-on subtotal
subscriptions.addons.discountsarrayApplied discount codes or objects for the add-on
Instructions
subscriptions.instructionsarrayPricing and timing instructions for each subscription period
subscriptions.instructions.productstringProduct path associated with the instruction
subscriptions.instructions.typestringInstruction type (e.g., regular)
subscriptions.instructions.periodStartDateintegerStart date of the instruction period in milliseconds
subscriptions.instructions.periodEndDatenull|integerEnd date of the instruction period when present
subscriptions.instructions.intervalUnitstringBilling interval unit for the instruction
subscriptions.instructions.intervalLengthintegerNumber of interval units for the instruction period
subscriptions.instructions.discountDurationUnitnull|stringUnit for remaining discount duration, when applicable
subscriptions.instructions.discountDurationLengthnull|integerLength of remaining discount duration, when applicable
subscriptions.instructions.discountPercentnumberDiscount percentage
subscriptions.instructions.discountTotalnumberTotal discount amount
subscriptions.instructions.unitDiscountnumberPer-unit discount
subscriptions.instructions.pricenumberUnit price
subscriptions.instructions.priceTotalnumberTotal price for the instruction
subscriptions.instructions.unitPricenumberUnit price before taxes
subscriptions.instructions.totalnumberTotal amount before taxes
subscriptions.instructions.totalWithTaxesnumberTotal amount including taxes
subscriptions.instructions.totalWithTaxesDisplaystringFormatted total including taxes
subscriptions.instructions.isNotTrialbooleanWhether the instruction is not a trial