Skip to main content
POST
Cancel a subscription

Path Parameters

Request Body

Example Request

Response

When cancel_at_period_end is true, the subscription remains active until current_period_end.

Errors

See Errors for the error envelope and the full code taxonomy.

Authorizations

Authorization
string
header
required

Tenant API key obtained from POST /auth/register or POST /v1/developer/keys.

Path Parameters

id
string<uuid>
required

Body

application/json
reason
enum<string>
required
Available options:
too_expensive,
not_using,
switching_competitor,
missing_features,
technical_issues,
customer_service,
temporary_pause,
other
cancel_at_period_end
boolean

Defaults to true when immediately is false.

immediately
boolean
feedback
string

Also revoke the recurring-payment consent (RBI compliance).

Response

Cancellation accepted.

id
string<uuid>
status
string
cancel_at_period_end
boolean
cancelled_at
string<date-time>
current_period_end
string<date-time>
cancellation_reason
string
message
string