Co-term Payment Overdue

Event payload example and property overview for subscription.group.payment.overdue

Webhook response payload example (expansion enabled)

When a subscription.group.payment.overdue 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",
  "cotermNextChargeDate": 1744329600000,
  "cotermNextChargeTotal": 40,
  "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"
  },
  "scheduledEvents": null,
  "subscriptions": [
  {
  "id": "1abc2DE_FGhIjKLm3NoPQR",
  "active": true,
  "state": "overdue",
  "isSubscriptionEligibleForPauseByBuyer": false,
  "isPauseScheduled": false,
  "changed": 1739203715234,
  "live": false,
  "currency": "USD",
  "product": {
      "product": "cloud-storage",
      "parent": null,
      "productAppReference": "1aB_CDeFGh2IJk34_5LmN",
      "display": {
      "en": "Cloud Storage Service"
      },
      "description": {
      "summary": {
          "en": "Cloud Storage Service"
      }
      },
      "image": null,
      "fulfillments": {},
      "format": "digital",
      "taxcode": "DC020500",
      "taxcodeDescription": null,
      "pricing": {
      "interval": "month",
      "intervalLength": 1,
      "intervalCount": null,
      "quantityBehavior": "allow",
      "quantityDefault": 1,
      "price": {
          "USD": 10
      },
      "dateLimitsEnabled": false,
      "reminderNotification": {
          "enabled": true,
          "interval": "week",
          "intervalLength": 1
      },
      "overdueNotification": {
          "enabled": true,
          "interval": "week",
          "intervalLength": 1,
          "amount": 4
      },
      "cancellation": {
          "interval": "week",
          "intervalLength": 1
      }
      }
  },
  "sku": null,
  "display": "Cloud Storage Service",
  "quantity": 1,
  "adhoc": false,
  "autoRenew": true,
  "price": 10,
  "discount": 0,
  "subtotal": 20,
  "next": 1744329600000,
  "end": null,
  "canceledDate": null,
  "deactivationDate": null,
  "sequence": 1,
  "periods": null,
  "remainingPeriods": null,
  "begin": 1738265837569,
  "intervalUnit": "month",
  "intervalUnitAbbreviation": "mo",
  "intervalLength": 1,
  "nextChargeCurrency": "USD",
  "nextChargeDate": 1744329600000,
  "nextChargePreTax": 18.52,
  "nextChargeTotal": 20,
  "addons": null,
  "discounts": null,
  "instructions": [
      {
      "product": "cloud-storage",
      "type": "regular",
      "isNotTrial": true,
      "periodStartDate": 1738195200000,
      "periodStartDateValue": 1738195200000,
      "periodStartDateInSeconds": 1738195200,
      "periodStartDateDisplay": "1/30/25",
      "periodStartDateDisplayISO8601": "2025-01-30",
      "periodEndDate": null,
      "periodEndDateValue": null,
      "periodEndDateInSeconds": null,
      "periodEndDateDisplay": null,
      "periodEndDateDisplayISO8601": null,
      "intervalUnit": "month",
      "intervalLength": 1,
      "discountPercent": 0,
      "discountPercentValue": 0,
      "discountPercentDisplay": "0%",
      "discountTotal": 0,
      "discountTotalDisplay": "$0.00",
      "discountTotalInPayoutCurrency": 0,
      "discountTotalInPayoutCurrencyDisplay": "$0.00",
      "unitDiscount": 0,
      "unitDiscountDisplay": "$0.00",
      "unitDiscountInPayoutCurrency": 0,
      "unitDiscountInPayoutCurrencyDisplay": "$0.00",
      "price": 10,
      "priceDisplay": "$10.00",
      "priceInPayoutCurrency": 10,
      "priceInPayoutCurrencyDisplay": "$10.00",
      "priceTotal": 20,
      "priceTotalDisplay": "$20.00",
      "priceTotalInPayoutCurrency": 20,
      "priceTotalInPayoutCurrencyDisplay": "$20.00",
      "unitPrice": 10,
      "unitPriceDisplay": "$10.00",
      "unitPriceInPayoutCurrency": 10,
      "unitPriceInPayoutCurrencyDisplay": "$10.00",
      "total": 20,
      "totalDisplay": "$20.00",
      "totalInPayoutCurrency": 20,
      "totalInPayoutCurrencyDisplay": "$20.00",
      "totalWithTaxes": 20,
      "totalWithTaxesDisplay": "$20.00",
      "totalWithTaxesInPayoutCurrency": 20,
      "totalWithTaxesInPayoutCurrencyDisplay": "$20.00"
      }
  ]
  },
  {
  "id": "2abc2DE_FGhIjKLm3NoPQR",
  "active": true,
  "state": "overdue",
  "isSubscriptionEligibleForPauseByBuyer": false,
  "isPauseScheduled": false,
  "changed": 1739203715234,
  "live": false,
  "currency": "USD",
  "product": {
      "product": "data-analytics",
      "parent": null,
      "productAppReference": "2aB_CDeFGh2IJk34_5LmN",
      "display": {
      "en": "Data Analytics Service"
      },
      "fulfillments": {},
      "format": "digital",
      "taxcode": "DC020500",
      "taxcodeDescription": null,
      "pricing": {
      "interval": "week",
      "intervalLength": 1,
      "intervalCount": null,
      "quantityBehavior": "allow",
      "quantityDefault": 1,
      "price": {
          "USD": 10
      },
      "dateLimitsEnabled": false,
      "reminderNotification": {
          "enabled": true,
          "interval": "week",
          "intervalLength": 1
      },
      "overdueNotification": {
          "enabled": true,
          "interval": "week",
          "intervalLength": 1,
          "amount": 4
      },
      "cancellation": {
          "interval": "week",
          "intervalLength": 1
      }
      }
  },
  "sku": null,
  "display": "Data Analytics Service",
  "quantity": 1,
  "adhoc": false,
  "autoRenew": true,
  "price": 10,
  "discount": 0,
  "subtotal": 10,
  "next": 1744329600000,
  "end": null,
  "canceledDate": null,
  "deactivationDate": null,
  "sequence": 1,
  "periods": null,
  "remainingPeriods": null,
  "begin": 1738256076037,
  "intervalUnit": "month",
  "intervalUnitAbbreviation": "mo",
  "intervalLength": 1,
  "nextChargeCurrency": "USD",
  "nextChargeDate": 1744329600000,
  "nextChargePreTax": 9.26,
  "nextChargeTotal": 10,
  "addons": null,
  "discounts": null,
  "instructions": [
      {
      "product": "data-analytics",
      "type": "regular",
      "isNotTrial": true,
      "periodStartDate": 1738195200000,
      "periodStartDateValue": 1738195200000,
      "periodStartDateInSeconds": 1738195200,
      "periodStartDateDisplay": "1/30/25",
      "periodStartDateDisplayISO8601": "2025-01-30",
      "periodEndDate": null,
      "periodEndDateValue": null,
      "periodEndDateInSeconds": null,
      "periodEndDateDisplay": null,
      "periodEndDateDisplayISO8601": null,
      "intervalUnit": "month",
      "intervalLength": 1,
      "discountPercent": 0,
      "discountPercentValue": 0,
      "discountPercentDisplay": "0%",
      "discountTotal": 0,
      "discountTotalDisplay": "$0.00",
      "discountTotalInPayoutCurrency": 0,
      "discountTotalInPayoutCurrencyDisplay": "$0.00",
      "unitDiscount": 0,
      "unitDiscountDisplay": "$0.00",
      "unitDiscountInPayoutCurrency": 0,
      "unitDiscountInPayoutCurrencyDisplay": "$0.00",
      "price": 10,
      "priceDisplay": "$10.00",
      "priceInPayoutCurrency": 10,
      "priceInPayoutCurrencyDisplay": "$10.00",
      "priceTotal": 10,
      "priceTotalDisplay": "$10.00",
      "priceTotalInPayoutCurrency": 10,
      "priceTotalInPayoutCurrencyDisplay": "$10.00",
      "unitPrice": 10,
      "unitPriceDisplay": "$10.00",
      "unitPriceInPayoutCurrency": 10,
      "unitPriceInPayoutCurrencyDisplay": "$10.00",
      "total": 10,
      "totalDisplay": "$10.00",
      "totalInPayoutCurrency": 10,
      "totalInPayoutCurrencyDisplay": "$10.00",
      "totalWithTaxes": 10,
      "totalWithTaxesDisplay": "$10.00",
      "totalWithTaxesInPayoutCurrency": 10,
      "totalWithTaxesInPayoutCurrencyDisplay": "$10.00"
      }
  ]
}
}

Navigate this webhook

The subscription.group.payment.overdue 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.payment.overdue 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)
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
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 customstringCustom 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
Scheduled Events
scheduledEventsarrayList of upcoming events for the group when present; null in this example
scheduledEvents.datestringDate and time of the scheduled event
scheduledEvents.typestringType of event (e.g., PAYMENT_OVERDUE)
Subscriptions array
subscriptionsarrayList of subscriptions in the co-term group
subscriptions.idstringSubscription ID
subscriptions.activebooleanWhether the subscription is active
subscriptions.statestringCurrent subscription state (e.g., overdue)
subscriptions.isSubscriptionEligibleForPauseByBuyerbooleanWhether the buyer can pause the subscription
subscriptions.isPauseScheduledbooleanWhether a pause is scheduled
subscriptions.changedintegerLast update timestamp in milliseconds
subscriptions.livebooleanWhether the subscription is in live mode
subscriptions.currencystringThree-letter ISO currency code
subscriptions.skustringSKU of the subscription product when provided
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.nextintegerNext billing date in milliseconds
subscriptions.endstringEnd date, when applicable
subscriptions.canceledDatestringCancellation date, when applicable
subscriptions.deactivationDatestringDeactivation date, when applicable
subscriptions.sequenceintegerSequence number for the billing period
subscriptions.periodsintegerTotal number of billing periods when fixed-term
subscriptions.remainingPeriodsintegerRemaining 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.nextChargeCurrencystringCurrency of the next charge
subscriptions.nextChargeDateintegerNext charge date in milliseconds
subscriptions.nextChargePreTaxnumberPre-tax amount for the next charge
subscriptions.nextChargeTotalnumberTotal next charge amount
Product
subscriptions.productobjectProduct object for the subscribed item
subscriptions.product.productstringProduct path or identifier
subscriptions.product.parentstringParent product when applicable
subscriptions.product.productAppReferencestringInternal application reference for the product
subscriptions.product.display.enstringEnglish display name of the product
subscriptions.product.description.summary.enstringEnglish summary description of the product
subscriptions.product.imagestringProduct image URL when configured
subscriptions.product.fulfillmentsobjectFulfillment configuration (object may be empty)
subscriptions.product.formatstringProduct format (e.g., digital)
subscriptions.product.taxcodestringTax code assigned to the product
subscriptions.product.taxcodeDescriptionstringDescription of the product tax code
Product pricing & policies
subscriptions.product.pricingobjectPricing settings for the product
subscriptions.product.pricing.intervalstringBilling interval (e.g., month or week)
subscriptions.product.pricing.intervalLengthintegerLength of the billing interval
subscriptions.product.pricing.intervalCountintegerNumber of intervals when applicable
subscriptions.product.pricing.quantityBehaviorstringQuantity behavior (e.g., allow)
subscriptions.product.pricing.quantityDefaultintegerDefault quantity for the product
subscriptions.product.pricing.priceobjectMap of currency codes to price amounts
subscriptions.product.pricing.price.EURnumberPrice in EUR when configured
subscriptions.product.pricing.price.USDnumberPrice in USD when configured
subscriptions.product.pricing.dateLimitsEnabledbooleanWhether pricing date limits are enforced
subscriptions.product.pricing.reminderNotification.enabledbooleanWhether reminder notifications are enabled for this product
subscriptions.product.pricing.reminderNotification.intervalstringTime unit for reminders (e.g., week)
subscriptions.product.pricing.reminderNotification.intervalLengthintegerLength of the reminder interval
subscriptions.product.pricing.overdueNotification.enabledbooleanWhether overdue notifications are enabled
subscriptions.product.pricing.overdueNotification.intervalstringTime unit for overdue notifications
subscriptions.product.pricing.overdueNotification.intervalLengthintegerLength of the overdue notification interval
subscriptions.product.pricing.overdueNotification.amountnumberConfigured amount related to overdue notifications
subscriptions.product.pricing.cancellation.intervalstringTime unit for cancellation timing
subscriptions.product.pricing.cancellation.intervalLengthintegerLength of the cancellation interval
Instructions
subscriptions.instructionsarrayPricing and timing instructions for the current period
subscriptions.instructions.productstringProduct path associated with the instruction
subscriptions.instructions.typestringInstruction type (e.g., regular)
subscriptions.instructions.isNotTrialbooleanWhether the instruction is not a trial
subscriptions.instructions.periodStartDateintegerPeriod start in milliseconds
subscriptions.instructions.periodStartDateValueintegerAlternate representation of period start (ms)
subscriptions.instructions.periodStartDateInSecondsintegerPeriod start in seconds
subscriptions.instructions.periodStartDateDisplaystringDisplay version of the period start date
subscriptions.instructions.periodStartDateDisplayISO8601stringISO 8601 period start date
subscriptions.instructions.periodEndDateintegerPeriod end in milliseconds when present
subscriptions.instructions.periodEndDateValueintegerAlternate representation of period end (ms) when present
subscriptions.instructions.periodEndDateInSecondsintegerPeriod end in seconds when present
subscriptions.instructions.periodEndDateDisplaystringDisplay version of the period end date when present
subscriptions.instructions.periodEndDateDisplayISO8601stringISO 8601 period end date when present
subscriptions.instructions.intervalUnitstringInterval unit (e.g., month)
subscriptions.instructions.intervalLengthnumberInterval length
subscriptions.instructions.discountPercentnumberDiscount percentage
subscriptions.instructions.discountPercentValuenumberAlternate numeric representation of discount percentage
subscriptions.instructions.discountPercentDisplaystringFormatted discount percentage (e.g., 0%)
subscriptions.instructions.discountTotalnumberTotal discount
subscriptions.instructions.discountTotalDisplaystringFormatted total discount
subscriptions.instructions.discountTotalInPayoutCurrencynumberTotal discount in payout currency
subscriptions.instructions.discountTotalInPayoutCurrencyDisplaystringFormatted total discount in payout currency
subscriptions.instructions.unitDiscountnumberPer-unit discount
subscriptions.instructions.unitDiscountDisplaystringFormatted per-unit discount
subscriptions.instructions.unitDiscountInPayoutCurrencynumberPer-unit discount in payout currency
subscriptions.instructions.unitDiscountInPayoutCurrencyDisplaystringFormatted per-unit discount in payout currency
subscriptions.instructions.pricenumberBase unit price
subscriptions.instructions.priceDisplaystringFormatted base price
subscriptions.instructions.priceInPayoutCurrencynumberBase price in payout currency
subscriptions.instructions.priceInPayoutCurrencyDisplaystringFormatted base price in payout currency
subscriptions.instructions.priceTotalnumberTotal price for the period
subscriptions.instructions.priceTotalDisplaystringFormatted total price
subscriptions.instructions.priceTotalInPayoutCurrencynumberTotal price in payout currency
subscriptions.instructions.priceTotalInPayoutCurrencyDisplaystringFormatted total price in payout currency
subscriptions.instructions.unitPricenumberUnit price before taxes
subscriptions.instructions.unitPriceDisplaystringFormatted unit price
subscriptions.instructions.unitPriceInPayoutCurrencynumberUnit price in payout currency
subscriptions.instructions.unitPriceInPayoutCurrencyDisplaystringFormatted unit price in payout currency
subscriptions.instructions.totalnumberTotal amount before taxes
subscriptions.instructions.totalDisplaystringFormatted total amount
subscriptions.instructions.totalInPayoutCurrencynumberTotal amount in payout currency
subscriptions.instructions.totalInPayoutCurrencyDisplaystringFormatted total in payout currency
subscriptions.instructions.totalWithTaxesnumberTotal including taxes
subscriptions.instructions.totalWithTaxesDisplaystringFormatted total including taxes
subscriptions.instructions.totalWithTaxesInPayoutCurrencynumberTotal including taxes in payout currency
subscriptions.instructions.totalWithTaxesInPayoutCurrencyDisplaystringFormatted total including taxes in payout currency