Cancel Change Request

DELETE

/api/:account_id/subscriptions/:subscription_id/change-requests/:request_id

DELETE

/api/:account_id/subscriptions/:subscription_id/change-requests/:request_id

$ curl -X DELETE https://app.paymentkit.com/api/account_id/subscriptions/subscription_id/change-requests/request_id \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

1 {
2   "change_request": {
3     "id": "cr_9f8b7a6c-1234-4d56-8e9f-abcdef123456",
4     "subscription_id": "sub_4d3c2b1a-5678-4e90-b123-fedcba987654",
5     "status": "cancelled",
6     "item_changes_count": 2,
7     "coupon_changes_count": 1,
8     "balance_changes_count": 0,
9     "created_at": "2024-01-10T08:15:00Z",
10     "updated_at": "2024-01-15T09:30:00Z",
11     "expires_at": null,
12     "applied_at": null,
13     "last_preview_at": "2024-01-14T12:00:00Z",
14     "reason": "User requested cancellation due to change in billing preferences."
15   }
16 }

Cancel a change request. The change request must be in draft or ready state. Cancelled change requests cannot be reactivated.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

subscription_idstringRequired

request_idstringRequired

account_idstringRequired

Response

Successful Response

change_requestobject

Response containing a change request.

Errors

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error