v69

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

Subscriptions

Update a subscription

Updates an active subscription's properties including billing period, add-ons, unit quantities, and discounts.

patch/api/v1/subscriptions/{id}

Path parameters

idstring required

The unique identifier of the entity

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

metadataobject

Additional metadata for the subscription

trialEndDatestring date-time

Subscription trial end date

promotionCodestring

Promotion code

billingPeriod'MONTHLY' | 'ANNUALLY'

awaitPaymentConfirmationboolean

Await payment confirmation

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

billingCycleAnchor'UNCHANGED' | 'NOW'

cancellationDatestring date-time nullable

Subscription cancellation date

salesforceIdstring nullable

Salesforce ID

Response

The updated subscription object.