Co-term Group Prorated

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

Webhook response payload example (expansion enabled)

When a subscription.group.prorated 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",
  "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",
  "total": null,
  "status": null,
  "timestamp": null,
  "paymentOverdue": {
    "intervalUnit": "week",
    "intervalLength": 1,
    "total": 4,
    "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"
  },
  "order": {
    "id": "aBCDE12fGH3iJkL4mNOpq",
    "reference": null,
    "buyerReference": null,
    "ipAddress": null,
    "completed": false,
    "changed": 1739225061515,
    "language": "en",
    "live": false,
    "currency": "USD",
    "payoutCurrency": "USD",
    "invoiceUrl": "https://company.onfastspring.com/account/order/null/invoice",
    "siteId": "ABC1DE2FGHIJ3",
    "acquisitionTransactionType": "GROUP_PRORATION",
    "total": 7.14,
    "tax": 0.2,
    "subtotal": 6.94,
    "discount": 42.76,
    "discountWithTax": 44.26,
    "proratedCreditTotal": 42.76,
    "proratedDebitTotal": 49.9,
    "proratedTotal": 7.14,
    "isScsProratedOrder": true,
    "isScsProratedOrderUpgrade": true,
    "billDescriptor": "N/A",
    "lastFourDigits": null,
    "paymentMethodType": null,
    "initialOrderId": null,
    "initialOrderReference": null,
    "previousOrderReference": "ABC123456-7891-01112",
    "previousOrderInvoiceUrl": "https://company.onfastspring.com/account/order/ABC123456-7891-01112/invoice/IV5YCOAFL2XVCRFLIPJTIZMTRDWE",
    "payment": null,
    "notes": [],
    "items": [
      {
        "product": "cloud-storage",
        "quantity": 1,
        "sku": "SKU-CS-101",
        "display": "Cloud Storage Service",
        "imageUrl": null,
        "shortDisplay": "Cloud Storage Service",
        "subtotal": 1.33,
        "attributes": {
          "pathFrom": "cloud-storage-service",
          "pathTo": "cloud-storage-service",
          "display": "Subscription: Cloud Storage Service - Changes: ",
          "totalChange": 0,
          "totalProratedCharge": 10,
          "totalProratedCredit": 8.5714,
          "totalNetCharge": 1.4286,
          "previousCharge": 10,
          "upcomingCharge": 10,
          "utilizedPrevious": 1.4286,
          "lapsedPrevious": 0
        },
        "discount": 8.57,
        "changeQuantity": false,
        "subscription": "1abc2DE_FGhIjKLm3NoPQR",
        "fulfillments": null,
        "withholdings": {
          "amount": null,
          "percentage": null,
          "taxWithholdings": false
        },
        "proratedItemChangeAmount": 0,
        "proratedItemProratedCharge": 10,
        "proratedItemCreditAmount": 8.57,
        "proratedItemTaxAmount": 0.1,
        "proratedItemTotal": 1.43
      },
      {
        "product": "data-analytics-service",
        "quantity": 1,
        "sku": "SKU-DA-102",
        "display": "Data Analytics Service",
        "sku": null,
        "imageUrl": null,
        "shortDisplay": "Data Analytics Service",
        "subtotal": 1.33,
        "attributes": {
          "pathFrom": "data-analytics-service",
          "pathTo": "data-analytics-service",
          "display": "Subscription: Data Analytics Service - Changes: ",
          "totalChange": 0,
          "totalProratedCharge": 10,
          "totalProratedCredit": 8.5714,
          "totalNetCharge": 1.4286,
          "previousCharge": 10,
          "upcomingCharge": 10,
          "utilizedPrevious": 1.4286,
          "lapsedPrevious": 0
        },
        "discount": 8.57,
        "changeQuantity": false,
        "subscription": "2abc2DE_FGhIjKLm3NoPQR",
        "fulfillments": null,
        "withholdings": {
          "amount": null,
          "percentage": null,
          "taxWithholdings": false
        },
        "proratedItemChangeAmount": 0,
        "proratedItemProratedCharge": 10,
        "proratedItemCreditAmount": 8.57,
        "proratedItemTaxAmount": 0.1,
        "proratedItemTotal": 1.43
      }
    ]
  },
  "subscriptions": [
    {
      "id": "1abc2DE_FGhIjKLm3NoPQR",
      "active": true,
      "state": "active",
      "isSubscriptionEligibleForPauseByBuyer": false,
      "isPauseScheduled": false,
      "changed": 1739225061876,
      "live": false,
      "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"
      },
      "product": "cloud-storage",
      "sku": "SKU-CS-101",
      "display": "Cloud Storage Service",
      "quantity": 1,
      "adhoc": false,
      "autoRenew": true,
      "price": 10,
      "discount": 0,
      "subtotal": 24.95,
      "next": 1739836800000,
      "end": null,
      "canceledDate": null,
      "deactivationDate": null,
      "sequence": 1,
      "periods": null,
      "remainingPeriods": null,
      "begin": 1739224859171,
      "intervalUnit": "week",
      "intervalUnitAbbreviation": "wk",
      "intervalLength": 1,
      "intervalLengthGtOne": false,
      "nextChargeCurrency": "USD",
      "nextChargeDate": 1739836800000,
      "nextChargePreTax": 23.1,
      "nextChargeTotal": 24.95,
      "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,
      "changed": 1739225061876,
      "live": false,
      "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"
      },
      "product": "data-analytics",
      "sku": "SKU-DA-102",
      "display": "Data Analytics Service",
      "quantity": 1,
      "adhoc": false,
      "autoRenew": true,
      "price": 10,
      "discount": 0,
      "subtotal": 24.95,
      "next": 1739836800000,
      "end": null,
      "canceledDate": null,
      "deactivationDate": null,
      "sequence": 1,
      "periods": null,
      "remainingPeriods": null,
      "begin": 1739224823223,
      "intervalUnit": "week",
      "intervalUnitAbbreviation": "wk",
      "intervalLength": 1,
      "intervalLengthGtOne": false,
      "nextChargeCurrency": "USD",
      "nextChargeDate": 1739836800000,
      "nextChargePreTax": 23.1,
      "nextChargeTotal": 24.95,
      "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.prorated 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.prorated 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
Event Summary
totalnull|numberTotal amount associated with the event when present
statusnull|stringStatus of the event when present
timestampnull|integerEvent timestamp in milliseconds when present
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
Order object
orderobjectOrder object containing proration details
order.idstringUnique order identifier
order.referencenull|stringCustomer-facing order reference when present
order.buyerReferencenull|stringBuyer-provided reference (e.g., PO number) when present
order.ipAddressnull|stringIP address captured for the order when available
order.completedbooleanWhether the order has completed processing
order.changedintegerLast order update timestamp in milliseconds
order.languagestringTwo-letter ISO language code
order.livebooleanWhether the order was processed in live mode
order.currencystringTransaction currency
order.payoutCurrencystringPayout currency
order.invoiceUrlstringURL to view or download the invoice
order.siteIdstringIdentifier of the site where the order occurred
order.acquisitionTransactionTypestringType of proration acquisition (e.g., GROUP_PRORATION)
order.totalnumberTotal order amount
order.taxnumberTax amount applied to the proration
order.subtotalnumberSubtotal before tax and discounts
order.discountnumberTotal discount applied
order.discountWithTaxnumberTotal discount including tax
order.proratedCreditTotalnumberTotal credited amount due to proration
order.proratedDebitTotalnumberTotal charged amount due to proration
order.proratedTotalnumberNet proration amount (debits minus credits)
order.isScsProratedOrderbooleanWhether this order is a proration
order.isScsProratedOrderUpgradebooleanWhether the proration reflects an upgrade
order.billDescriptorstringBilling descriptor that may appear on the buyer’s statement
order.lastFourDigitsnull|stringLast four digits of the payment card when applicable
order.paymentMethodTypenull|stringPayment method type when available
order.initialOrderIdnull|stringInitial order ID when applicable
order.initialOrderReferencenull|stringInitial order reference when applicable
order.previousOrderReferencestringReference of the previous order related to this proration
order.previousOrderInvoiceUrlstringInvoice URL of the previous order
order.paymentnull|objectPayment object when available; null in this example
order.notesarrayArray of order notes (often empty)
Order items (within order)
order.itemsarrayList of proration line items
order.items.productstringProduct identifier or path
order.items.quantityintegerQuantity for the item
order.items.skunull|stringSKU when provided
order.items.displaystringCustomer-facing product name
order.items.imageUrlnull|stringImage URL when available
order.items.shortDisplaystringShort display name
order.items.subtotalnumberItem subtotal before tax
order.items.attributesobjectProration attribute deltas for this item
order.items.attributes.pathFromstringPrevious product path
order.items.attributes.pathTostringNew product path
order.items.attributes.displaystringHuman-readable summary of the change
order.items.attributes.totalChangenumberNet change applied to the item
order.items.attributes.totalProratedChargenumberTotal prorated charge for the item
order.items.attributes.totalProratedCreditnumberTotal prorated credit for the item
order.items.attributes.totalNetChargenumberNet charge (charge minus credit)
order.items.attributes.previousChargenumberPrevious full-period charge
order.items.attributes.upcomingChargenumberUpcoming full-period charge
order.items.attributes.utilizedPreviousnumberValue of the already-used previous period
order.items.attributes.lapsedPreviousnumberValue of the lapsed previous period
order.items.discountnumberDiscount applied to the item
order.items.changeQuantitybooleanWhether quantity changed as part of the proration
order.items.subscriptionstringSubscription ID associated with the item
order.items.fulfillmentsnull|objectFulfillment details when present
order.items.withholdings.amountnull|numberAmount withheld for this item when applicable
order.items.withholdings.percentagenull|numberWithholding percentage when applicable
order.items.withholdings.taxWithholdingsbooleanWhether tax withholdings apply
order.items.proratedItemChangeAmountnumberChange amount due to proration
order.items.proratedItemProratedChargenumberProrated charge component
order.items.proratedItemCreditAmountnumberProrated credit component
order.items.proratedItemTaxAmountnumberTax applied to the proration
order.items.proratedItemTotalnumberTotal proration amount for the item
Subscriptions array
subscriptionsarrayList of subscriptions in the co-term group (post-proration)
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.changedintegerLast update timestamp in milliseconds
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.nextintegerNext billing date in milliseconds
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., week or month)
subscriptions.intervalUnitAbbreviationstringAbbreviation of the interval unit (e.g., wk or 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