Cancel a subscription

post/v1/subscriptions/{subscriptionId}/cancel

Request

Base URL
https://api.breeze.cash
Auth
HTTP basic
TypeScript
https://skmtc.dev/breeze/apis/breeze-api/docs/v1/subscriptions/:subscriptionId/cancel/post.ts
A function with typed inputs. Its response is checked against the schema.

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

Changes

No recorded changes to this operation across all 2 revisions of this API.