v69

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-011221331.4 MB

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.