Update Subscription Lifecycle Settings

PATCH

/api/accounts/:account_id/subscription-lifecycle-settings

Update subscription lifecycle settings for an account.

Controls how subscriptions behave during lifecycle events:

resume_billing_behavior: How to bill when resuming a paused subscription
- ‘reset_anchor’: Re-anchor billing to resume date (no catch-up)
- ‘catch_up’: Preserve original anchor, generate catch-up invoices

Update subscription lifecycle settings for an account. Controls how subscriptions behave during lifecycle events: - resume_billing_behavior: How to bill when resuming a paused subscription - 'reset_anchor': Re-anchor billing to resume date (no catch-up) - 'catch_up': Preserve original anchor, generate catch-up invoices

Authentication

AuthorizationBearer

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

Path parameters

account_idstringRequired

Request

This endpoint expects an object.

resume_billing_behaviorenum or nullOptional

Controls how subscriptions are billed when resumed after a pause. ‘reset_anchor’ re-anchors billing to the resume date. ‘catch_up’ preserves the original anchor and generates catch-up invoices.

Response

Successful Response

resume_billing_behaviorenum or nullOptionalDefaults to reset_anchor

Controls how subscriptions are billed when resumed after a pause. ‘reset_anchor’ (default) re-anchors billing to the resume date with no catch-up charges. ‘catch_up’ preserves the original billing anchor and generates catch-up invoices for elapsed cycles.

Errors

422

Unprocessable Entity Error

$	curl -X PATCH https://app.paymentkit.com/api/accounts/account_id/subscription-lifecycle-settings \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'