v69

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

Subscriptions

Provision subscription

Creates a new subscription for an existing customer. When payment is required and no payment method exists, returns a checkout URL.

post/api/v1/subscriptions

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

idstring

Unique identifier for the subscription

customerIdstring required

Customer ID to provision the subscription for

planIdstring required

Plan ID to provision

payingCustomerIdstring nullable

Optional paying customer ID for split billing scenarios

resourceIdstring nullable

Optional resource ID for multi-instance subscriptions

billingPeriod'MONTHLY' | 'ANNUALLY'

Billing period (MONTHLY or ANNUALLY)

startDatestring date-time

Subscription start date

cancellationDatestring date-time

Subscription cancellation date

billingIdstring nullable

External billing system identifier

billingCountryCodestring nullable

The ISO 3166-1 alpha-2 country code for billing

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

Strategy for scheduling subscription changes

metadataobject

Additional metadata for the subscription

salesforceIdstring nullable

Salesforce ID

paymentCollectionMethod'CHARGE' | 'INVOICE' | 'NONE'

How payments should be collected for this subscription

awaitPaymentConfirmationboolean

Whether to wait for payment confirmation before returning the subscription

unitQuantityinteger

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

billingCycleAnchor'UNCHANGED' | 'NOW'

Billing cycle anchor behavior for the subscription

Response

The newly created subscription object.