Execute Pending Change

POST

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

POST

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

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

1 {
2   "executed": true,
3   "reason": null,
4   "plan_change_result": {
5     "original_subscription_id": "sub_8f3b2c1d4e5f6789",
6     "original_cancelled": true,
7     "original_items_remaining": 0,
8     "original_subscription_updated_at": "2024-01-15T09:30:00Z",
9     "created_subscriptions": [
10       {
11         "subscription_id": "sub_9a7d6e5f4b3c2a1e",
12         "state": "active",
13         "billing_interval": "month",
14         "billing_interval_count": 1,
15         "items_count": 3,
16         "updated_at": "2024-01-15T09:30:00Z",
17         "total_billing_cycles": null,
18         "contract_auto_renew": true
19       }
20     ],
21     "items_added": 3,
22     "proration_credit_atom": -1500,
23     "proration_charge_atom": 2000,
24     "net_amount_atom": 500,
25     "invoice_id": "inv_20240115_001",
26     "payment_status": "paid",
27     "voided_invoice_ids": [
28       "inv_20231215_007"
29     ],
30     "effective_at": "period_end",
31     "scheduled_for": "2024-01-31T23:59:59Z",
32     "pending_change_id": "chg_20240115_1234"
33   }
34 }

Execute a pending plan change (internal - called by Restate at period_end).

This endpoint is called by the Restate workflow when a subscription reaches its period end and has a pending plan change to execute.

Requires workflow authentication (X-Restate-Secret-Key header).

Returns:

executed: True if the pending change was executed
reason: Reason for skipping if not executed
plan_change_result: Full plan change result if executed

Execute a pending plan change (internal - called by Restate at period_end). This endpoint is called by the Restate workflow when a subscription reaches its period end and has a pending plan change to execute. Requires workflow authentication (X-Restate-Secret-Key header). Returns: - executed: True if the pending change was executed - reason: Reason for skipping if not executed - plan_change_result: Full plan change result if executed

Authentication

AuthorizationBearer

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

Path parameters

subscription_idstringRequired

account_idstringRequired

Response

Successful Response

executedboolean

True if pending change was executed

reasonstring or nullOptional

Reason for skipping if not executed

plan_change_resultobject or nullOptional

Full plan change result if executed

Errors

422

Unprocessable Entity Error

Authentication

Path parameters

Headers

Response

Errors