Cancel immediately or at period end.

Authorization

ApiKeyAuth

x-api-key<token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

reason?string

immediate?boolean

Response Body

`application/json`

curl -X POST "https://example.com/subscriptions/string/cancel" \  -H "Content-Type: application/json" \  -d '{}'

{  "success": true,  "data": {    "id": "string",    "customerId": "string",    "status": "draft",    "canceledAt": "2019-08-24T14:15:22Z",    "cancelReason": "string",    "scheduledCancellationDate": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "object": "subscription",    "livemode": true  }}

{  "success": false,  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}

{  "success": false,  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}

{  "success": false,  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}

{  "success": false,  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}

{  "success": false,  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}

Cancel subscription

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

404application/json

409application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`