Pause a subscription
Pauses a subscription now, or from its next renewal with mode: period_end (a gym member keeps the month they paid for and the pause starts where it ends). A pause booked for the renewal shows in scheduledChanges as pause, the renewal is skipped while it is due, and resuming before it starts takes the booking back. Either way, with resumesAt it resumes on its own on that date. A pause from the renewal starts a fresh period on the day it resumes, so the paused time is never billed. A pause now holds back days already paid for, so resuming moves the next renewal out by however long it lasted: paused on 10 February in a month paid to 28 February and back on 20 March, the 18 paid days run from 20 March and the next renewal is 7 April. A paused subscription grants no entitlements.
Authorizations
Use a Bouclay secret key (sk_test_..., sk_live_...) or restricted key
(rk_test_..., rk_live_...).
A secret key can call every endpoint. A restricted key can only call the
endpoints its scopes cover. A scope is {resource}:{access}, for example
customers:read or refunds:write, and write includes read. GET
requests need read access and everything else needs write, except
POST /subscriptions/{id}/items/{item}/preview, which only needs
subscriptions:read. A request outside the key's scopes gets 403 permission_denied naming the missing scope, and its Idempotency-Key
is not used up.
Publishable keys (pk_...) are rejected by server-side API endpoints. A
key's mode scopes what it can see and charge: a test key can never reach
a live card.
Headers
Required for POST and PATCH requests. Replays identical method + path + body requests and rejects mismatched re-use.
1 - 255Path Parameters
Body
now (the default) or period_end. period_end needs an active subscription not set to cancel, and one pause booked at a time.
now, period_end, null When it resumes on its own. With period_end, after the renewal it pauses from.