v1

latestOpenAPI 3.1.0Proprietary2026-07-1434570540.9 KB
Payments

Renew a subscription

Renews a single subscription period: the facilitator settles the period charge on-chain and advances the current period end.

post/payments/subscriptions/{id}/renew

Path parameters

idstring required

Subscription id to renew (the subscriptionId, e.g. sub_xyz).

Request body

paymentAuthorizationstring required

Base64 Ed25519 signature of the standing upto authorization the subscriber signed at creation. Verified against the standing authorization message (never a per-period nonce); used to settle this period's charge.

settledAmountstring

Optional actual amount to settle this period in base units (integer string), bounded by the plan amount. Defaults to the plan's per-period charge.

Response

OK

object required