Developer Hub
Sign In
Start typing to search…

Co-term Payment Reminder

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

Webhook response payload example (expansion enabled)

When a subscription.group.payment.reminder 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",
  "cotermGroupOrderId": "aBCDE12fGH3iJkL4mNOpq",
  "cotermNextChargeDate": 1756646400000,
  "cotermNextChargeTotal": 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",
  "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"
  },
  "reminderNotification": null,
  "cancellationSetting": {
    "cancellation": "AFTER_LAST_NOTIFICATION",
    "intervalUnit": "week",
    "intervalLength": 1
  },
  "scheduledEvents": [
    {
      "date": "11/20/2025 03:00:00",
      "type": "PAYMENT_REMINDER"
    },
    {
      "date": "11/27/2025 08:00:00",
      "type": "RENEWAL"
    },
    {
      "date": "11/28/2025 08:00:00",
      "type": "FOLLOW_UP"
    },
    {
      "date": "12/01/2025 08:00:00",
      "type": "FOLLOW_UP"
    },
    {
      "date": "12/04/2025 03:00:00",
      "type": "PAYMENT_OVERDUE"
    },
    {
      "date": "12/06/2025 08:00:00",
      "type": "FOLLOW_UP"
    },
    {
      "date": "12/11/2025 03:00:00",
      "type": "PAYMENT_OVERDUE"
    },
    {
      "date": "12/18/2025 03:00:00",
      "type": "PAYMENT_OVERDUE"
    },
    {
      "date": "12/25/2025 03:00:00",
      "type": "PAYMENT_OVERDUE"
    },
    {
      "date": "01/01/2026 08:00:00",
      "type": "DEACTIVATION"
    }
  ],
  "subscriptions": [
    {
      "id": "1abc2DE_FGhIjKLm3NoPQR",
      "quote": null,
      "active": true,
      "state": "active",
      "isSubscriptionEligibleForPauseByBuyer": false,
      "isPauseScheduled": false,
      "changed": 1.732038466488E12,
      "live": false,
      "currency": "USD",
      "product": {
        "product": "cloud-storage",
        "parent": null,
        "productAppReference": "1aB_CDeFGh2IJk34_5LmN",
        "display": {
          "en": "Cloud Storage Service"
        },
        "fulfillments": {
          
        },
        "format": "digital",
        "taxcode": "DC020400",
        "taxcodeDescription": null,
        "pricing": {
          "interval": "week",
          "intervalLength": 1.0,
          "intervalCount": null,
          "quantityBehavior": "allow",
          "quantityDefault": 1.0,
          "price": {
            "EUR": 100.0,
            "USD": 100.0
          },
          "dateLimitsEnabled": false
        }
      },
      "sku": null,
      "display": "Cloud Storage Service",
      "quantity": 1.0,
      "adhoc": false,
      "autoRenew": true,
      "price": 100.0,
      "discount": 0.0,
      "subtotal": 100.0,
      "end": null,
      "canceledDate": null,
      "deactivationDate": null,
      "sequence": 1.0,
      "periods": null,
      "remainingPeriods": null,
      "begin": 1.732038207127E12,
      "intervalUnit": "week",
      "intervalUnitAbbreviation": "wk",
      "intervalLength": 1.0,
      "intervalLengthGtOne": false,
      "nextChargeCurrency": "USD",
      "nextChargeDate": 1.7326656E12,
      "nextChargePreTax": 92.81,
      "nextChargeTotal": 100.0,
      "taxExemptionData": null,
      "nextNotificationType": null,
      "nextNotificationDate": null,
      "addons": null,
      "discounts": null,
      "fulfillments": {
        
      },
      "instructions": [
        {
          "product": "cloud-storage",
          "type": "regular",
          "isNotTrial": true,
          "periodStartDate": 1.7326656E12,
          "periodEndDate": null,
          "discountIntervalUnit": null,
          "discountDurationLength": null,
          "discountDuration": null,
          "discountDurationUnit": null,
          "unitDiscount": 0.0,
          "discountPercent": 0.0,
          "discountTotal": 0.0,
          "price": 100.0,
          "priceTotal": 100.0,
          "unitPrice": 100.0,
          "unitPriceInPayoutCurrencyDisplay": "$100.00",
          "total": 100.0,
          "totalWithTaxes": 100.0
        }
      ]
    },
    {
      "id": "2abc2DE_FGhIjKLm3NoPQR",
      "quote": null,
      "active": true,
      "state": "active",
      "isSubscriptionEligibleForPauseByBuyer": false,
      "isPauseScheduled": false,
      "changed": 1.732038466489E12,
      "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.0,
          "intervalCount": null,
          "quantityBehavior": "allow",
          "quantityDefault": 1.0,
          "price": {
            "USD": 0.23
          },
          "dateLimitsEnabled": false
        }
      },
      "sku": null,
      "display": "Data Analytics Service",
      "quantity": 1.0,
      "adhoc": false,
      "autoRenew": true,
      "price": 0.23,
      "discount": 0.0,
      "subtotal": 0.23,
      "end": null,
      "canceledDate": null,
      "deactivationDate": null,
      "sequence": 1.0,
      "periods": null,
      "remainingPeriods": null,
      "begin": 1.732038186499E12,
      "intervalUnit": "week",
      "intervalUnitAbbreviation": "wk",
      "intervalLength": 1.0,
      "intervalLengthGtOne": false,
      "nextChargeCurrency": "USD",
      "nextChargeDate": 1.7326656E12,
      "nextChargePreTax": 0.23,
      "nextChargeTotal": 0.23,
      "taxExemptionData": null,
      "nextNotificationType": null,
      "nextNotificationDate": null,
      "addons": null,
      "discounts": null,
      "fulfillments": {
        
      },
      "instructions": [
        {
          "product": "data-analytics",
          "type": "regular",
          "isNotTrial": true,
          "periodStartDate": 1.7326656E12,
          "periodEndDate": null,
          "discountIntervalUnit": null,
          "discountDurationLength": null,
          "discountDuration": null,
          "discountDurationUnit": null,
          "unitDiscount": 0.0,
          "discountPercent": 0.0,
          "discountTotal": 0.0,
          "price": 0.23,
          "priceTotal": 0.23,
          "unitPrice": 0.23,
          "unitPriceInPayoutCurrencyDisplay": "$0.23",
          "total": 0.23,
          "totalWithTaxes": 0.23
        }
      ]
    }
  ]
}

Navigate this webhook

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

Co-term Group

Changed Timestamps

Next Charge

Account Object

Reminder Notification

Cancellation Settings

Scheduled Events

Subscriptions Array

Product

Pricing (within Product)

Instructions

Add-ons & Discounts

Fulfillments

Payload properties

All fields below are included in the subscription.group.payment.reminder 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
cotermNextChargeDateintegerNext charge date for the co-term group in milliseconds since epoch
cotermNextChargeTotalnumberTotal amount for the next group charge
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
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
Reminder Notification
reminderNotificationobjectReminder configuration when present; null in this example
reminderNotification.enabledbooleanWhether reminder notifications are enabled (when object present)
reminderNotification.intervalstringTime unit for reminders (e.g., week)
reminderNotification.intervalLengthintegerLength of the reminder interval
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
Scheduled Events
scheduledEventsarrayList of upcoming events for the group
scheduledEvents.datestringDate and time of the scheduled event
scheduledEvents.typestringType of event (e.g., PAYMENT_REMINDER, RENEWAL, PAYMENT_OVERDUE, DEACTIVATION)
Subscriptions array
subscriptionsarrayList of subscriptions in the co-term group
subscriptions.idstringSubscription ID
subscriptions.quotestringAssociated quote ID when present
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.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.quantitynumberQuantity 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.endstringEnd date, when applicable
subscriptions.canceledDatestringCancellation date, when applicable
subscriptions.deactivationDatestringDeactivation date, when applicable
subscriptions.sequencenumberSequence number for the billing period
subscriptions.periodsnumberTotal number of billing periods when fixed-term
subscriptions.remainingPeriodsnumberRemaining number of billing periods
subscriptions.beginnumberActivation timestamp in milliseconds
subscriptions.intervalUnitstringBilling interval unit (e.g., week)
subscriptions.intervalUnitAbbreviationstringAbbreviation of the interval unit (e.g., wk)
subscriptions.intervalLengthnumberNumber of interval units per billing period
subscriptions.intervalLengthGtOnebooleanWhether the interval length is greater than one
subscriptions.nextChargeCurrencystringCurrency of the next charge
subscriptions.nextChargeDatenumberNext charge date in milliseconds
subscriptions.nextChargePreTaxnumberPre-tax amount for the next charge
subscriptions.nextChargeTotalnumberTotal next charge amount
subscriptions.taxExemptionDatastringTax exemption details when applicable
subscriptions.nextNotificationTypestringType of the next notification when scheduled
subscriptions.nextNotificationDatenumberTimestamp of the next notification when scheduled
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.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
Pricing (within product)
subscriptions.product.pricingobjectPricing settings for the product
subscriptions.product.pricing.intervalstringBilling interval (e.g., week)
subscriptions.product.pricing.intervalLengthnumberLength of the billing interval
subscriptions.product.pricing.intervalCountnumberNumber of intervals when applicable
subscriptions.product.pricing.quantityBehaviorstringQuantity behavior (e.g., allow)
subscriptions.product.pricing.quantityDefaultnumberDefault 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
Add-ons & Discounts
subscriptions.addonsarrayArray of add-on items when present
subscriptions.discountsarrayArray of discount objects when present
subscriptions.discounts.totalDiscountValuenumberTotal discount amount that will apply to the order
subscriptions.discounts.discountPathstringPath or identifier for the discount
subscriptions.discounts.discountDurationstringDuration of the discount
subscriptions.discounts.discountValuenumberPer-billing discount amount in order currency (for non-percent coupons)
Fulfillments
subscriptions.fulfillmentsobjectFulfillment details (object may be empty)
Instructions
subscriptions.instructionsarrayPricing and timing instructions for the upcoming 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.periodStartDatenumberStart date of the instruction period in milliseconds
subscriptions.instructions.periodEndDatenumberEnd date of the instruction period when present
subscriptions.instructions.discountIntervalUnitstringInterval unit for discounts when applicable
subscriptions.instructions.discountDurationLengthnumberLength of discount duration when applicable
subscriptions.instructions.discountDurationnumberRemaining discount duration when applicable
subscriptions.instructions.discountDurationUnitstringUnit of remaining discount duration when applicable
subscriptions.instructions.unitDiscountnumberPer-unit discount
subscriptions.instructions.discountPercentnumberDiscount percentage
subscriptions.instructions.discountTotalnumberTotal discount for the instruction
subscriptions.instructions.pricenumberUnit price
subscriptions.instructions.priceTotalnumberTotal price for the instruction
subscriptions.instructions.unitPricenumberUnit price before taxes
subscriptions.instructions.unitPriceInPayoutCurrencyDisplaystringFormatted unit price in payout currency
subscriptions.instructions.totalnumberTotal amount before taxes
subscriptions.instructions.totalWithTaxesnumberTotal amount including taxes