Add a charge to current subscribers
A charge added to a plan reaches new subscribers only. This gives it to each live subscriber of the plan at their next renewal (a scheduled change, shown on the subscription and removable until then), or at once when trialing or paused, since nothing is billed. A subscriber is left out, with the reason, when the charge has no single price in their way to pay, when its meter is already billed on the subscription, or when a plan change is pending. Running it again skips what is already done or queued.
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 - 255