---
title: "Generate co-term group estimate"
method: POST
path: "/subscriptions/coterm/{cotermGroupId}/estimate"
tags: ["Subscriptions"]
---

# Generate co-term group estimate

`POST /subscriptions/coterm/{cotermGroupId}/estimate`

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

## Path parameters

- `cotermGroupId` string, required

## Response `200`

OK

- CoTermEstimateResponse — Response containing pricing and proration estimates.
  - `action` string — The action performed.
  - `result` string — The result of the operation.
  - `coTermGroupId` string — Unique identifier for the co-term group.
  - `account` string — Account ID associated with the group.
  - `currency` string — The currency code for the estimate.
  - `UTC` string — The timezone used for the estimate dates.
  - `periodStartDate` integer — Timestamp of the estimated period start.
  - `periodStartDateDisplay` string — Human-readable display of the period start date.
  - `periodStartDateDisplayISO8601` string — ISO8601 formatted string of the period start date.
  - `periodEndDate` integer — Timestamp of the estimated period end.
  - `periodEndDateDisplay` string — Human-readable display of the period end date.
  - `periodEndDateDisplayISO8601` string — ISO8601 formatted string of the period end date.
  - `subscriptions` SubscriptionEstimate[] — Detailed breakdown of the estimate per subscription.
    - `subscription` string — The subscription ID.
    - `currency` string — Currency code.
    - `timezone` string — Timezone code.
    - `periodStartDate` integer — Timestamp of the period start.
    - `periodStartDateDisplay` string — Display string for period start.
    - `periodStartDateDisplayISO8601` string — ISO8601 string for period start.
    - `periodEndDate` integer — Timestamp of the period end.
    - `periodEndDateDisplay` string — Display string for period end.
    - `periodEndDateDisplayISO8601` string — ISO8601 string for period end.
    - `remainingPeriods` integer — Number of periods remaining.
    - `nextChargeDate` integer — Timestamp of the next charge.
    - `nextChargeDateDisplay` string — Display string for next charge.
    - `nextChargeDateDisplayISO8601` string — ISO8601 string for next charge.
    - `isProratable` boolean — Whether the subscription supports proration.
    - `prorationStatus` string — Status of the proration calculation.
    - `currentPlan` PlanSnapshot — Snapshot of the pricing plan for estimation.
      - `display` string — Display name of the product/plan.
      - `product` string — Product path ID.
      - `billingFrequency` string — Frequency of the billing cycle.
      - `price` number — Unit price of the product.
      - `priceDisplay` string — Formatted unit price.
      - `discount` number — Discount amount applied.
      - `discountDisplay` string — Formatted discount amount.
      - `quantity` integer — Quantity of the product.
      - `subtotal` number — Subtotal before tax.
      - `subtotalDisplay` string — Formatted subtotal.
      - `tax` number — Tax amount.
      - `taxDisplay` string — Formatted tax amount.
      - `total` number — Total amount including tax.
      - `totalDisplay` string — Formatted total amount.
      - `taxPercent` number — Tax percentage applied.
      - `taxPercentDisplay` string — Formatted tax percentage.
      - `periodStartDate` integer — Timestamp of plan period start.
      - `periodStartDateDisplay` string — Display string for period start.
      - `periodStartDateDisplayISO8601` string — ISO8601 string for period start.
      - `periodEndDate` integer — Timestamp of plan period end.
      - `periodEndDateDisplay` string — Display string for period end.
      - `periodEndDateDisplayISO8601` string — ISO8601 string for period end.
      - `prorationUtilizedDays` integer — Number of days utilized in the proration.
      - `prorationRemainingDays` integer — Number of days remaining in the proration.
      - `prorationTotalDays` integer — Total days in the proration period.
      - `proratedItemCharge` number — Charge amount for the prorated period.
      - `proratedItemChargeDisplay` string — Formatted prorated charge.
      - `proratedItemCredit` number — Credit amount for the prorated period.
      - `proratedItemCreditDisplay` string — Formatted prorated credit.
      - `proratedItemSubtotal` number — Subtotal of proration adjustments.
      - `proratedItemSubtotalDisplay` string — Formatted proration subtotal.
      - `proratedItemTax` number — Tax on the prorated amount.
      - `proratedItemTaxDisplay` string — Formatted proration tax.
      - `proratedItemTotal` number — Total prorated amount.
      - `proratedItemTotalDisplay` string — Formatted total prorated amount.
      - `addons` AddonSnapshot[] — List of add-ons included in the plan.
        - `display` string — Display name of the add-on.
        - `product` string — Product path ID of the add-on.
        - `priceDisplay` string — Formatted price of the add-on.
        - `proratedItemChargeDisplay` string — Formatted prorated charge for the add-on.
      - `subscriptionSubtotal` number — Subscription subtotal.
      - `subscriptionSubtotalDisplay` string — Formatted subscription subtotal.
      - `subscriptionTax` number — Subscription tax.
      - `subscriptionTaxDisplay` string — Formatted subscription tax.
      - `subscriptionTotal` number — Subscription total.
      - `subscriptionTotalDisplay` string — Formatted subscription total.
      - `subscriptionProratedCredit` number — Credit amount for subscription proration.
      - `subscriptionProratedCreditDisplay` string — Formatted credit amount.
      - `subscriptionProratedCharge` number — Charge amount for subscription proration.
      - `subscriptionProratedChargeDisplay` string — Formatted charge amount.
    - `proposedPlan` PlanSnapshot — Snapshot of the pricing plan for estimation.
      - `display` string — Display name of the product/plan.
      - `product` string — Product path ID.
      - `billingFrequency` string — Frequency of the billing cycle.
      - `price` number — Unit price of the product.
      - `priceDisplay` string — Formatted unit price.
      - `discount` number — Discount amount applied.
      - `discountDisplay` string — Formatted discount amount.
      - `quantity` integer — Quantity of the product.
      - `subtotal` number — Subtotal before tax.
      - `subtotalDisplay` string — Formatted subtotal.
      - `tax` number — Tax amount.
      - `taxDisplay` string — Formatted tax amount.
      - `total` number — Total amount including tax.
      - `totalDisplay` string — Formatted total amount.
      - `taxPercent` number — Tax percentage applied.
      - `taxPercentDisplay` string — Formatted tax percentage.
      - `periodStartDate` integer — Timestamp of plan period start.
      - `periodStartDateDisplay` string — Display string for period start.
      - `periodStartDateDisplayISO8601` string — ISO8601 string for period start.
      - `periodEndDate` integer — Timestamp of plan period end.
      - `periodEndDateDisplay` string — Display string for period end.
      - `periodEndDateDisplayISO8601` string — ISO8601 string for period end.
      - `prorationUtilizedDays` integer — Number of days utilized in the proration.
      - `prorationRemainingDays` integer — Number of days remaining in the proration.
      - `prorationTotalDays` integer — Total days in the proration period.
      - `proratedItemCharge` number — Charge amount for the prorated period.
      - `proratedItemChargeDisplay` string — Formatted prorated charge.
      - `proratedItemCredit` number — Credit amount for the prorated period.
      - `proratedItemCreditDisplay` string — Formatted prorated credit.
      - `proratedItemSubtotal` number — Subtotal of proration adjustments.
      - `proratedItemSubtotalDisplay` string — Formatted proration subtotal.
      - `proratedItemTax` number — Tax on the prorated amount.
      - `proratedItemTaxDisplay` string — Formatted proration tax.
      - `proratedItemTotal` number — Total prorated amount.
      - `proratedItemTotalDisplay` string — Formatted total prorated amount.
      - `addons` AddonSnapshot[] — List of add-ons included in the plan.
        - `display` string — Display name of the add-on.
        - `product` string — Product path ID of the add-on.
        - `priceDisplay` string — Formatted price of the add-on.
        - `proratedItemChargeDisplay` string — Formatted prorated charge for the add-on.
      - `subscriptionSubtotal` number — Subscription subtotal.
      - `subscriptionSubtotalDisplay` string — Formatted subscription subtotal.
      - `subscriptionTax` number — Subscription tax.
      - `subscriptionTaxDisplay` string — Formatted subscription tax.
      - `subscriptionTotal` number — Subscription total.
      - `subscriptionTotalDisplay` string — Formatted subscription total.
      - `subscriptionProratedCredit` number — Credit amount for subscription proration.
      - `subscriptionProratedCreditDisplay` string — Formatted credit amount.
      - `subscriptionProratedCharge` number — Charge amount for subscription proration.
      - `subscriptionProratedChargeDisplay` string — Formatted charge amount.
    - `amountDue` AmountDue — Summary of amounts due.
      - `prorationSubtotal` number — Subtotal of proration amounts.
      - `prorationSubtotalDisplay` string — Formatted proration subtotal.
      - `prorationTax` number — Tax on proration amounts.
      - `prorationTaxDisplay` string — Formatted proration tax.
      - `totalAmountDue` number — Total amount due now.
      - `totalAmountDueDisplay` string — Formatted total amount due.
      - `nextChargeDate` integer — Timestamp of the next charge.
      - `nextChargeDateDisplay` string — Display string for next charge date.
      - `nextChargeDateDisplayISO8601` string — ISO8601 string for next charge date.
      - `nextChargeAmount` number — Amount of the next charge.
      - `nextChargeAmountDisplay` string — Formatted amount of the next charge.
    - `discountTotals` DiscountTotals — Summary of discount totals.
      - `productLevelDiscountTotal` number — Total product-level discounts.
      - `productLevelDiscountTotalDisplay` string — Formatted total product-level discounts.
      - `couponLevelDiscountTotal` number — Total coupon-level discounts.
      - `couponLevelDiscountTotalDisplay` string — Formatted total coupon-level discounts.
    - `status` string — Overall status of the estimate for this subscription.
  - `amountDueTotal` AmountDue — Summary of amounts due.
    - `prorationSubtotal` number — Subtotal of proration amounts.
    - `prorationSubtotalDisplay` string — Formatted proration subtotal.
    - `prorationTax` number — Tax on proration amounts.
    - `prorationTaxDisplay` string — Formatted proration tax.
    - `totalAmountDue` number — Total amount due now.
    - `totalAmountDueDisplay` string — Formatted total amount due.
    - `nextChargeDate` integer — Timestamp of the next charge.
    - `nextChargeDateDisplay` string — Display string for next charge date.
    - `nextChargeDateDisplayISO8601` string — ISO8601 string for next charge date.
    - `nextChargeAmount` number — Amount of the next charge.
    - `nextChargeAmountDisplay` string — Formatted amount of the next charge.

---

[API](https://skmtc.net/fastspring/apis/fastspring-api-accounts.md) · [All operations](https://skmtc.net/fastspring/apis/fastspring-api-accounts/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fastspring/fastspring-api-accounts/versions/ae2f0b97db3e/schema)