v1

latestOpenAPI 3.1.02026-07-245575200.1 KB

Subscriptions

Cancel a subscription

post/v1/subscriptions/{subscriptionId}/cancel

Path parameters

subscriptionIdstring required

Subscription ID

Request body

cancelAtPeriodEndboolean

If true, the subscription will be canceled at the end of the current billing period instead of immediately. Ignored for INCOMPLETE and SCHEDULED subscriptions, which are always canceled immediately.

Response

Success

status'SUCCEEDED' required