MRR waterfall, retention, churn and cohorts
Early access. Not yet turned on for every account: until it is, this answers 404 not_found. Build against it now and ask us to turn it on.
The report for one currency over the last months calendar months (UTC), the current month running to now. Movements are per customer: a customer who swaps one subscription for another is expansion or contraction, not churn plus new. Each month satisfies startMrr + new + expansion - contraction - churn + reactivation = endMrr.
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.
Query Parameters
ISO 4217 code. Defaults to the team currency, or the first currency with revenue.
"NGN"
1 <= x <= 36