Reschedule Billing

POST

/api/:account_id/subscriptions/:subscription_id/reschedule-billing

Reschedule subscription billing date.

Changes current_period_end and triggers Restate re-evaluation. Old scheduled billing actions are automatically superseded.

Requirements:

Subscription must be in ACTIVE state
No unpaid invoices (open or draft) can exist
next_billing_date must be in the future

Preview mode:

Set is_preview=true to calculate changes without applying them
Useful for showing customers what the new billing date would be

Proration (optional):

Set create_proration=true to create proration items for the time difference
This is a future enhancement and currently has no effect

Returns:

subscription_id: The subscription’s ID
current_period_end: The new billing date
previous_period_end: The old billing date
lifecycle_triggered: Whether Restate was notified to re-evaluate

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

Reschedule subscription billing date. Changes current_period_end and triggers Restate re-evaluation. Old scheduled billing actions are automatically superseded. Requirements: - Subscription must be in ACTIVE state - No unpaid invoices (open or draft) can exist - next_billing_date must be in the future Preview mode: - Set is_preview=true to calculate changes without applying them - Useful for showing customers what the new billing date would be Proration (optional): - Set create_proration=true to create proration items for the time difference - This is a future enhancement and currently has no effect Returns: - subscription_id: The subscription's ID - current_period_end: The new billing date - previous_period_end: The old billing date - lifecycle_triggered: Whether Restate was notified to re-evaluate 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

Request

This endpoint expects an object.

next_billing_datedatetimeRequired

New billing date (must be in the future)

create_prorationbooleanOptionalDefaults to false

Create proration items for time difference

is_previewbooleanOptionalDefaults to false

Calculate without applying changes

Response

Successful Response

subscription_idstring

current_period_enddatetime

previous_period_enddatetime

proration_credit_amount_atomintegerOptionalDefaults to 0

proration_charge_amount_atomintegerOptionalDefaults to 0

lifecycle_triggeredbooleanOptionalDefaults to false

is_previewbooleanOptionalDefaults to false

Errors

422

Unprocessable Entity Error

$	curl -X POST https://app.paymentkit.com/api/account_id/subscriptions/subscription_id/reschedule-billing \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"next_billing_date": "2024-07-01T10:00:00Z"
>	}'

1	{
2	"subscription_id": "sub_9f8b7c6d5e4a3b2c1d0e",
3	"current_period_end": "2024-07-01T10:00:00Z",
4	"previous_period_end": "2024-06-01T10:00:00Z",
5	"proration_credit_amount_atom": 0,
6	"proration_charge_amount_atom": 0,
7	"lifecycle_triggered": true,
8	"is_preview": false
9	}