Cancel Pending Change

DELETE

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

DELETE

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

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

1 {
2   "status": "cancelled",
3   "subscription_id": "sub_8f3a2b1c9d4e7f6a",
4   "previous_pending_change": {
5     "id": "pc_4d5e6f7a8b9c0d1e",
6     "created_at": "2024-01-10T14:22:00Z",
7     "scheduled_for": "2024-01-31T23:59:59Z",
8     "items": [
9       {
10         "action": "add",
11         "subscription_item_id": null,
12         "new_price_id": "price_123abc456def789ghi",
13         "quantity": 2,
14         "new_product_name": "Premium Streaming Plan"
15       }
16     ],
17     "reason": "Upgrade to premium tier",
18     "proration_behavior": "create_prorations",
19     "metadata": {
20       "requested_by": "user_987654321",
21       "notes": "Customer requested upgrade effective period end"
22     }
23   }
24 }

Cancel a pending plan change scheduled for period_end.

If a subscription has a pending plan change (scheduled via effective_at: "period_end"), this endpoint cancels it.

Returns the details of the cancelled pending change, or status “not_found” if no pending change exists.

Works for both User and API Key authentication. Account access is automatically validated via endpoint dependency.

Cancel a pending plan change scheduled for period_end. If a subscription has a pending plan change (scheduled via `effective_at: "period_end"`), this endpoint cancels it. Returns the details of the cancelled pending change, or status "not_found" if no pending change exists. Works for both User and API Key authentication. Account access is automatically validated via endpoint dependency.

Authentication

AuthorizationBearer

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

Path parameters

subscription_idstringRequired

account_idstringRequired

Response

Successful Response

statusenum

‘cancelled’ if pending change was removed, ‘not_found’ if none existed

subscription_idstring

ID of the subscription

previous_pending_changeobject or nullOptional

The cancelled pending change details (if any)

Errors

422

Unprocessable Entity Error