v1

latestOpenAPI 3.0.02026-07-2475182625.5 KB

Subscriptions

Generate co-term group estimate

Calculates proration, tax, and next charge amounts for a co-term group without executing the changes.

post/subscriptions/coterm/{cotermGroupId}/estimate

Path parameters

cotermGroupIdstring required

Example:X_yZ1a2Bc3De4Fg5Hi6JkL

Unique identifier for the co-term group.

Response

actionstring

The action performed.

resultstring

The result of the operation.

coTermGroupIdstring

Unique identifier for the co-term group.

accountstring

Account ID associated with the group.

currencystring

The currency code for the estimate.

UTCstring

The timezone used for the estimate dates.

periodStartDateinteger

Timestamp of the estimated period start.

periodStartDateDisplaystring

Human-readable display of the period start date.

periodStartDateDisplayISO8601string

ISO8601 formatted string of the period start date.

periodEndDateinteger

Timestamp of the estimated period end.

periodEndDateDisplaystring

Human-readable display of the period end date.

periodEndDateDisplayISO8601string

ISO8601 formatted string of the period end date.

Example response

{
  "action": "subscriptions.coterm.estimate",
  "result": "success",
  "coTermGroupId": "X_yZ1a2Bc3De4Fg5Hi6JkL",
  "account": "Mn7Op8Qr9St0Uv1Wx2Yz3A",
  "currency": "USD",
  "UTC": "UTC",
  "periodStartDate": 1770076800000,
  "periodStartDateDisplay": "2/3/26",
  "periodStartDateDisplayISO8601": "2026-02-03",
  "periodEndDate": 1772409600000,
  "periodEndDateDisplay": "3/2/26",
  "periodEndDateDisplayISO8601": "2026-03-02",
  "subscriptions": [
    {
      "subscription": "Ab1C-DeFgH-iJ2K3l4MmNo",
      "currency": "USD",
      "timezone": "UTC",
      "periodStartDate": 1769990400000,
      "periodStartDateDisplay": "2/2/26",
      "periodStartDateDisplayISO8601": "2026-02-02",
      "periodEndDate": 1772323200000,
      "periodEndDateDisplay": "3/1/26",
      "periodEndDateDisplayISO8601": "2026-03-01",
      "remainingPeriods": -1,
      "nextChargeDate": 1772496000000,
      "nextChargeDateDisplay": "3/3/26",
      "nextChargeDateDisplayISO8601": "2026-03-03",
      "isProratable": true,
      "prorationStatus": "Available",
      "currentPlan": {
        "display": "Furious Falcon Analytics",
        "product": "furious-falcon-analytics",
        "billingFrequency": "1 month",
        "price": 100,
        "priceDisplay": "$100.00",
        "discountDisplay": "$0.00",
        "quantity": 1,
        "subtotal": 100,
        "subtotalDisplay": "$100.00",
        "tax": 8,
        "taxDisplay": "$8.00",
        "total": 108,
        "totalDisplay": "$108.00",
        "taxPercent": 8,
        "taxPercentDisplay": "8%",
        "periodStartDate": 1769990400000,
        "periodStartDateDisplay": "2/2/26",
        "periodStartDateDisplayISO8601": "2026-02-02",
        "periodEndDate": 1769990400000,
        "periodEndDateDisplay": "2/2/26",
        "periodEndDateDisplayISO8601": "2026-02-02",
        "prorationRemainingDays": 28,
        "prorationTotalDays": 28,
        "proratedItemCharge": 103.57,
        "proratedItemChargeDisplay": "$103.57",
        "proratedItemCredit": 100,
        "proratedItemCreditDisplay": "$100.00",
        "proratedItemSubtotal": 3.57,
        "proratedItemSubtotalDisplay": "$3.57",
        "proratedItemTax": 0.28,
        "proratedItemTaxDisplay": "$0.28",
        "proratedItemTotal": 3.85,
        "proratedItemTotalDisplay": "$3.85",
        "addons": [
          {
            "display": "Addon Name",
            "product": "addon-product-path",
            "priceDisplay": "$5.00",
            "proratedItemChargeDisplay": "$2.50"
          }
        ],
        "subscriptionSubtotal": 100,
        "subscriptionSubtotalDisplay": "$100.00",
        "subscriptionTax": 8,
        "subscriptionTaxDisplay": "$8.00",
        "subscriptionTotal": 108,
        "subscriptionTotalDisplay": "$108.00",
        "subscriptionProratedCredit": 100,
        "subscriptionProratedCreditDisplay": "$100.00",
        "subscriptionProratedCharge": 103.57,
        "subscriptionProratedChargeDisplay": "$103.57"
      },
      "proposedPlan": {
        "display": "Furious Falcon Analytics",
        "product": "furious-falcon-analytics",
        "billingFrequency": "1 month",
        "price": 100,
        "priceDisplay": "$100.00",
        "discountDisplay": "$0.00",
        "quantity": 1,
        "subtotal": 100,
        "subtotalDisplay": "$100.00",
        "tax": 8,
        "taxDisplay": "$8.00",
        "total": 108,
        "totalDisplay": "$108.00",
        "taxPercent": 8,
        "taxPercentDisplay": "8%",
        "periodStartDate": 1769990400000,
        "periodStartDateDisplay": "2/2/26",
        "periodStartDateDisplayISO8601": "2026-02-02",
        "periodEndDate": 1769990400000,
        "periodEndDateDisplay": "2/2/26",
        "periodEndDateDisplayISO8601": "2026-02-02",
        "prorationRemainingDays": 28,
        "prorationTotalDays": 28,
        "proratedItemCharge": 103.57,
        "proratedItemChargeDisplay": "$103.57",
        "proratedItemCredit": 100,
        "proratedItemCreditDisplay": "$100.00",
        "proratedItemSubtotal": 3.57,
        "proratedItemSubtotalDisplay": "$3.57",
        "proratedItemTax": 0.28,
        "proratedItemTaxDisplay": "$0.28",
        "proratedItemTotal": 3.85,
        "proratedItemTotalDisplay": "$3.85",
        "addons": [
          {
            "display": "Addon Name",
            "product": "addon-product-path",
            "priceDisplay": "$5.00",
            "proratedItemChargeDisplay": "$2.50"
          }
        ],
        "subscriptionSubtotal": 100,
        "subscriptionSubtotalDisplay": "$100.00",
        "subscriptionTax": 8,
        "subscriptionTaxDisplay": "$8.00",
        "subscriptionTotal": 108,
        "subscriptionTotalDisplay": "$108.00",
        "subscriptionProratedCredit": 100,
        "subscriptionProratedCreditDisplay": "$100.00",
        "subscriptionProratedCharge": 103.57,
        "subscriptionProratedChargeDisplay": "$103.57"
      },
      "amountDue": {
        "prorationSubtotal": 3.57,
        "prorationSubtotalDisplay": "$3.57",
        "prorationTax": 0.28,
        "prorationTaxDisplay": "$0.28",
        "totalAmountDue": 3.85,
        "totalAmountDueDisplay": "$3.85",
        "nextChargeDate": 1772496000000,
        "nextChargeDateDisplay": "3/3/26",
        "nextChargeDateDisplayISO8601": "2026-03-03",
        "nextChargeAmount": 108,
        "nextChargeAmountDisplay": "$108.00"
      },
      "discountTotals": {
        "productLevelDiscountTotalDisplay": "$0.00",
        "couponLevelDiscountTotalDisplay": "$0.00"
      },
      "status": "Ready to Prorate"
    }
  ],
  "amountDueTotal": {
    "prorationSubtotal": 3.57,
    "prorationSubtotalDisplay": "$3.57",
    "prorationTax": 0.28,
    "prorationTaxDisplay": "$0.28",
    "totalAmountDue": 3.85,
    "totalAmountDueDisplay": "$3.85",
    "nextChargeDate": 1772496000000,
    "nextChargeDateDisplay": "3/3/26",
    "nextChargeDateDisplayISO8601": "2026-03-03",
    "nextChargeAmount": 108,
    "nextChargeAmountDisplay": "$108.00"
  }
}