Create a product
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 - 255Body
How tax treats this product under your country's tax law. Defaults to standard.
standard, zero_rated, exempt The account in your books this product's sales post to. Frozen onto each invoice line.
64credit makes a credit pack preset: its prices are one-time packs of prepaid credit, and it can't have plans.
standard, credit Credit products only: when VAT is charged on credit bought as one of its packs. at_purchase taxes the top-up and spends the credit before tax; at_redemption leaves the top-up untaxed and spends the credit after tax. Defaults to your team default.
at_redemption, at_purchase Credit products only. Null for credit that never expires.
1 <= x <= 120