Addon Entitlements4

Addons9

Auto recharge1

Bulk Import2

Contracts6

Coupons5

Credit consumption2

Credit grants3

Credit ledger1

Credit usage1

Custom currencies6

Customer Integrations5

Customers9

Data Export6

Entitlements2

Features6

Governance Assignments2

Governance Entities5

Governance Entitlements Check1

Governance Entity Types2

Governance Hierarchy1

Invoices1

Plan Entitlements4

Plans10

Products6

Promotional Entitlements3

Subscriptions14

Usage5

Subscriptions

Preview subscription

Previews the pricing impact of creating or updating a subscription without making changes. Returns estimated costs, taxes, and proration details.

post/api/v1/subscriptions/preview

Headers

X-ACCOUNT-IDstring

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-IDstring

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Request body

customerIdstring required

Customer ID

payingCustomerIdstring

Paying customer ID for delegated billing

resourceIdstring

Resource ID for multi-instance subscriptions

planIdstring required

Plan ID

billingPeriod'MONTHLY' | 'ANNUALLY'

Billing period (MONTHLY or ANNUALLY)

billingCountryCodestring

ISO 3166-1 country code for localization

unitQuantityinteger

Unit quantity for per-unit pricing. Minimum is 0 (zero is allowed).

startDatestring date-time

Subscription start date

scheduleStrategy'END_OF_BILLING_PERIOD' | 'END_OF_BILLING_MONTH' | 'IMMEDIATE'

When to apply subscription changes

billingCycleAnchor'UNCHANGED' | 'NOW'

Billing cycle anchor behavior for the subscription

Response

The subscription preview with pricing breakdown.

Changes

Changed in 8 of the 115 revisions of this API.104

Jul 23, 2026b876edd1a4fc51See the full diff
- ●
  added the new CreditOveragePriceCurrencyNotFound enum value to the code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new InvalidCreditOverageBillingModel enum value to the code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new InvoicePreviewNotAvailableForDraftContract enum value to the code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new OveragePriceNotSupportedOnAddon enum value to the code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new OveragePriceRequiresUsageLimit enum value to the code response property for the response status 400
  response-property-enum-value-added
- ○
  removed the InvoicePreviewNotAvailableForDraftContract enum value from the code response property for the response status 409
  response-property-enum-value-removed
Jul 8, 202658bb216ff8ce1See the full diff
- ●
  added the new GovernanceNotEnabled enum value to the code response property for the response status 403
  response-property-enum-value-added
Jun 15, 20267296f9e4b6541See the full diff
- ●
  added the new InvoicePreviewNotAvailableForDraftContract enum value to the code response property for the response status 409
  response-property-enum-value-added
Jun 8, 20263acd63d6c8612See the full diff
- ○
  added the new optional header request parameter X-ACCOUNT-ID
  new-optional-request-parameter
- ○
  added the new optional header request parameter X-ENVIRONMENT-ID
  new-optional-request-parameter
Jun 4, 20264fa87d66426d1See the full diff
- ●
  added the new PricingModelNotSupportedByBillingIntegration enum value to the code response property for the response status 400
  response-property-enum-value-added
May 31, 20260dece860f6781See the full diff
- ●
  added the new DataExportIntegrationError enum value to the code response property for the response status 400
  response-property-enum-value-added
May 28, 2026b181b166a2a51See the full diff
- ●
  added the new InvalidReceivedSignatureError enum value to the code response property for the response status 400
  response-property-enum-value-added
May 13, 202635fbd550dc281See the full diff
- ○
  the unitQuantity request property's min was decreased from 1.00 to 0.00
  request-property-min-decreased

Full history