Create Change Request

POST

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

POST

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

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

1 {
2   "change_request": {
3     "id": "cr_9f8b7a6c-1234-4d56-8e9f-0a1b2c3d4e5f",
4     "subscription_id": "sub_4a5b6c7d-89e0-1234-5678-9abcdef01234",
5     "status": "draft",
6     "item_changes_count": 0,
7     "coupon_changes_count": 0,
8     "balance_changes_count": 0,
9     "created_at": "2024-04-20T10:15:30Z",
10     "updated_at": "2024-04-20T10:15:30Z",
11     "expires_at": "2024-04-21T10:15:30Z",
12     "applied_at": "null",
13     "last_preview_at": "null",
14     "reason": "Initial change request draft for subscription update"
15   }
16 }

Create a new change request draft for a subscription.

Only one active (draft or previewed) change request can exist per subscription at a time.

Authentication

AuthorizationBearer

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

Path parameters

subscription_idstringRequired

account_idstringRequired

Request

This endpoint expects an object.

reasonstring or nullOptional<=255 characters

Optional reason for the change

expires_in_hoursinteger or nullOptional1-168

Hours until the draft expires (1-168). Default value (24 hours) is set at the use case layer.

Response

Successful Response

change_requestobject

Response containing a change request.

Errors

400

Bad Request Error

404

Not Found Error

422

Unprocessable Entity Error