v69

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

Subscriptions

Cancel subscription

Cancels an active subscription, either immediately or at a specified time such as end of billing period.

post/api/v1/subscriptions/{id}/cancel

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

endDatestring date-time

Subscription end date

cancellationAction'DEFAULT' | 'REVOKE_ENTITLEMENTS'

Action on cancellation (downgrade or revoke)

cancellationTime'END_OF_BILLING_PERIOD' | 'IMMEDIATE' | 'SPECIFIC_DATE'

When to cancel (immediate, period end, or date)

prorateboolean

If set, enables or disables prorating of credits on subscription cancellation.

Response

The subscription object reflecting the cancellation.