Create a meter
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.
A meter names an event your app sends and how Bouclay adds it up. It defines what is measured; a price decides what it costs, so one meter can back many prices.
eventName, aggregation, valueKey, and uniqueKey are fixed once
the meter has events, because changing them would reprice history.
To count differently, create a new meter.
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
255Unique per business.
100^[A-Za-z0-9][A-Za-z0-9._:-]*$count: the number of events.sum: the sum of each event's value.max: the largest value in the window.last: the value of the latest event.unique_count: the number of distinct values ofproperties.{uniqueKey}.
count, sum, max, last, unique_count For sum, max, and last, the property holding the number. Omit to read the event's value.
Required for unique_count.
50