> ## Documentation Index > Fetch the complete documentation index at: https://docs.bouclay.com/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve a customer's usage > **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. Each meter's usage for this customer over a half-open window `[start, end)`, computed from the events on read. Cancelled events don't count. Without `start` and `end`, a meter that one of the customer's live subscriptions bills for reports over that subscription's current period, with `estimatedAmount`: what the usage so far would bill, priced exactly as the invoice line will be. A meter that only a limit entitlement watches (a free tier's allowance) reports over the limit's period, the same count as the limit's `used`. Any other meter reports over the current calendar month in UTC. Each meter carries the customer's `limit` and `remaining` on it. With `start` or `end`, every meter reports over that window, aggregate only. ## OpenAPI ````yaml /api/openapi.yaml get /customers/{customer}/usage openapi: 3.1.0 info: title: Bouclay API version: 1.0.0 summary: Integrator API for Bouclay subscriptions, invoices, payments, and webhooks. description: > Bouclay is managed recurring-billing infrastructure for African payment gateways. Integrators connect their own gateway account (Bachs, with Nomba, Paystack and Flutterwave in early access) and use this API to manage customers, catalog, subscriptions, entitlements, usage metering, invoices, payment-method checkout sessions, payments, and outbound event history. Bouclay never holds funds — every charge, refund, and payout happens on your own gateway account, with your own keys. Which gateway settles a given charge is Bouclay's concern, not yours: a stored card always charges through the gateway that issued its token. ## Early access Some of this API is documented ahead of its release, so you can build against it now. Those operations carry an **Early access** badge, and so do the request fields that depend on them (graduated, volume and package pricing, usage-based prices, usage thresholds). Until a feature is turned on for your account, its endpoints answer `404 not_found`, its fields are refused with a `422`, and a restricted key cannot be given its scopes. Ask us to turn it on. Nothing you already rely on changes when it is. servers: - url: https://bouclay.com/api/v1 description: Production security: - SecretKeyAuth: [] tags: - name: Customers - name: Customer addresses - name: Payment methods - name: Entitlements description: >- Early access: answers `404 not_found` until it is turned on for your account. - name: Credits description: >- What a customer has left to spend. Money owed back to a customer is their balance, one per currency; their next invoice spends it after tax, like a payment, and collects the rest. Promotional credit you give is held in lots (credit grants), each with its own expiry; the next invoice spends it before tax, so it lowers the VAT like a discount. - name: Catalog - name: Payment links description: >- A shareable checkout page for one price, the same link a price's "Payment link" makes in the dashboard. Buyers enter their email and pay; a subscription price starts the subscription once paid. - name: Meters description: >- Early access: answers `404 not_found` until it is turned on for your account. - name: Usage description: >- Early access: answers `404 not_found` until it is turned on for your account. - name: Discounts description: >- Early access: answers `404 not_found` until it is turned on for your account. - name: Subscriptions - name: Invoices - name: Metrics description: >- Early access: answers `404 not_found` until it is turned on for your account. Revenue metrics measured from each subscription's monthly recurring amount (MRR). `active` and `past_due` subscriptions count; trials, pauses and metered usage do not. Amounts are major units, rates are percentages (105.25 means 105.25%), and currencies are never summed. - name: Credit notes description: >- A credit note corrects an issued invoice without changing it: "of this invoice, this much is no longer owed". Each one has its own number in an unbroken sequence (`{prefix}-CN-0001`) and never changes once issued. On an unpaid invoice the credit comes off `amountDue`; on a paid one it goes back to the customer, refunded to the card, added to the customer balance or settled outside Bouclay. What the customer balance paid of an invoice always goes back to the balance first. An invoice always satisfies `amountDue = total - amountPaid - amountCredited - balanceApplied`. Every refund also issues a credit note. - name: Payments - name: Refunds description: >- A refund goes back through the gateway that took the payment. Refund part of a payment and it stays `succeeded`; refund all of it and it becomes `refunded`. - name: Chargebacks description: >- A chargeback is a payment the customer's bank took back. Record one when your payment provider reports it, with the provider's dispute reference, then record how the dispute ended. While it is open, Bouclay doesn't charge or chase the subscription. A chargeback on a credit top-up takes back the unspent credit and its bonus; winning the dispute puts back exactly that. Uses the `refunds` scope. - name: Events - name: Checkout sessions - name: Portal sessions - name: Webhook endpoints paths: /customers/{customer}/usage: parameters: - name: customer in: path required: true schema: type: string description: A Bouclay customer ID, or the `externalRef` you gave the customer. example: ctm_123 get: tags: - Usage summary: Retrieve a customer's usage description: > **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. Each meter's usage for this customer over a half-open window `[start, end)`, computed from the events on read. Cancelled events don't count. Without `start` and `end`, a meter that one of the customer's live subscriptions bills for reports over that subscription's current period, with `estimatedAmount`: what the usage so far would bill, priced exactly as the invoice line will be. A meter that only a limit entitlement watches (a free tier's allowance) reports over the limit's period, the same count as the limit's `used`. Any other meter reports over the current calendar month in UTC. Each meter carries the customer's `limit` and `remaining` on it. With `start` or `end`, every meter reports over that window, aggregate only. operationId: retrieveCustomerUsage parameters: - name: start in: query schema: type: string format: date-time description: >- Start of the window, inclusive. Defaults to the first of this month, UTC. - name: end in: query schema: type: string format: date-time description: End of the window, exclusive. Defaults to one month after `start`. - name: meter in: query schema: type: string description: Only this meter, by ID or event name. responses: '200': $ref: '#/components/responses/CustomerUsage' '404': $ref: '#/components/responses/Error' '422': $ref: '#/components/responses/Error' components: responses: CustomerUsage: description: A customer's usage per meter. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResourceEnvelope' - type: object properties: data: $ref: '#/components/schemas/CustomerUsage' Error: description: Structured API error. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' schemas: ResourceEnvelope: type: object required: - data - meta properties: data: type: object meta: $ref: '#/components/schemas/Meta' CustomerUsage: type: object properties: customer: type: string example: ctm_123 start: type: string format: date-time end: type: string format: date-time usage: type: array items: type: object properties: meter: type: object properties: id: type: string name: type: string eventName: type: string aggregation: $ref: '#/components/schemas/MeterAggregation' unitLabel: type: - string - 'null' status: type: string enum: - active - archived start: type: string format: date-time description: >- Start of this meter's window. For a meter a subscription bills, the later of its period's start and when the usage charge started (an upgrade mid-period counts from then). end: type: string format: date-time quantity: type: integer example: 13400 subscription: description: >- The subscription whose period the window is, when one bills this meter. type: - string - 'null' price: description: The metered price the usage is billed at. type: - string - 'null' limit: description: >- The customer's limit on this meter, from a limit entitlement. Null when it has none, it is unlimited, or a window was given. type: - integer - 'null' example: 100 remaining: description: >- `limit` less what was used over the limit's period, never below 0. Null without a limit. type: - integer - 'null' example: 60 estimatedAmount: description: >- What the usage so far would bill. Null when no subscription bills this meter, or a window was given. oneOf: - $ref: '#/components/schemas/MajorAmount' - type: 'null' spendingCaps: description: >- Each live subscription of the customer with a spending cap, and what its current period has spent toward it so far: the number to compare with the cap before letting the customer use more (Bouclay reports, your app decides). type: array items: type: object properties: subscription: type: string currency: type: string periodStart: type: string format: date-time periodEnd: type: string format: date-time amount: $ref: '#/components/schemas/MajorAmount' spent: $ref: '#/components/schemas/MajorAmount' remaining: $ref: '#/components/schemas/MajorAmount' reached: type: boolean covers: type: string enum: - usage - all behavior: type: string enum: - cap - warn ErrorResponse: type: object required: - error - meta properties: error: type: object required: - type - code - detail properties: type: type: string enum: - request_error - api_error description: >- `api_error` with code `internal_error` (HTTP 500) means the fault is ours: retry with the same Idempotency-Key. example: request_error code: type: string enum: - authentication_failed - permission_denied - invalid_field - invalid_cursor - idempotency_conflict - meter_not_found - meter_archived - customer_not_found - timestamp_in_future - usage_period_closed - subscription_paused - missing_property - invalid_value - conflict - subscription_suspended - no_upcoming_invoice - not_found - request_error - internal_error detail: type: string errors: type: array items: type: object required: - field - message properties: field: type: string message: type: string meta: $ref: '#/components/schemas/Meta' Meta: type: object required: - requestId properties: requestId: type: string example: req_550e8400-e29b-41d4-a716-446655440000 MeterAggregation: type: string enum: - count - sum - max - last - unique_count description: > - `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 of `properties.{uniqueKey}`. MajorAmount: type: - number - 'null' minimum: 0 description: Major currency units. For example, 15000 means NGN 15,000. securitySchemes: SecretKeyAuth: type: http scheme: bearer bearerFormat: '{sk|rk}_{mode}_{random}' description: > 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. | Resource | Endpoints | Access | | --- | --- | --- | | `customers` | customers, their addresses and payment methods | read, write | | `entitlements` | `/customers/{id}/entitlements` | read | | `credits` | `/customers/{id}/credit-balance`, credit purchases, credit grants, auto-reloads, credit holds (committing one records its usage) | read, write | | `catalog` | products, plans, prices | read, write | | `meters` | meters | read, write | | `usage` | meter events, `/customers/{id}/usage` | read, write | | `discounts` | discounts | read | | `subscriptions` | subscriptions | read, write | | `invoices` | invoices | read, write | | `credit_notes` | credit notes, `POST /invoices/{id}/credit-notes` (a refund to the card also needs `refunds:write`) | read, write | | `payments` | payments | read | | `refunds` | refunds, `POST /payments/{id}/refunds`, chargebacks and their outcome | read, write | | `checkout_sessions` | checkout sessions | read, write | | `portal_sessions` | portal sessions | write | | `events` | events | read | | `webhook_endpoints` | webhook endpoints | read, write | | `metrics` | metrics | read | 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. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.