> ## 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. # Commit what a request used > **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. Records what the request actually used and closes the hold in one step: one meter event per meter (identifier `{hold id}:{eventName}`, dated now), billed by the period's invoice like any other usage. The hold stops counting the moment its usage starts to, so the credit is never counted twice. A meter you leave out committed nothing. Less than was held releases the rest. More is accepted: the extra is ordinary usage, and what the credit can't cover is collected by the invoice. A committed hold is returned as it is when you retry, so no `Idempotency-Key` is needed. A hold past its expiry is refused with `409 hold_expired` (send the usage as a meter event instead), and a released one with `409 hold_settled`. Needs `credits:write` on a restricted key. ## OpenAPI ````yaml /api/openapi.yaml post /credit-holds/{creditHold}/commit 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: /credit-holds/{creditHold}/commit: parameters: - $ref: '#/components/parameters/CreditHoldId' post: tags: - Credits summary: Commit what a request used 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. Records what the request actually used and closes the hold in one step: one meter event per meter (identifier `{hold id}:{eventName}`, dated now), billed by the period's invoice like any other usage. The hold stops counting the moment its usage starts to, so the credit is never counted twice. A meter you leave out committed nothing. Less than was held releases the rest. More is accepted: the extra is ordinary usage, and what the credit can't cover is collected by the invoice. A committed hold is returned as it is when you retry, so no `Idempotency-Key` is needed. A hold past its expiry is refused with `409 hold_expired` (send the usage as a meter event instead), and a released one with `409 hold_settled`. Needs `credits:write` on a restricted key. operationId: commitCreditHold requestBody: required: true content: application/json: schema: type: object required: - usage properties: usage: type: array maxItems: 20 items: type: object required: - eventName - value properties: eventName: type: string example: tokens value: type: integer minimum: 0 example: 3120 responses: '200': $ref: '#/components/responses/CreditHold' '404': $ref: '#/components/responses/Error' '409': $ref: '#/components/responses/Error' '422': $ref: '#/components/responses/Error' components: parameters: CreditHoldId: name: creditHold in: path required: true schema: type: string example: hold_123 responses: CreditHold: description: Credit hold response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResourceEnvelope' - type: object properties: data: $ref: '#/components/schemas/CreditHold' 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' CreditHold: type: object description: >- Usage reserved against a customer's prepaid credit before a request, then committed or released. properties: id: type: string example: hold_123 object: type: string const: credit_hold customer: type: object properties: id: type: string status: type: string enum: - held - committed - released - expired currency: type: string example: NGN amount: type: number description: What the hold took from the credit when it was made, in major units. usage: type: array items: type: object properties: eventName: type: string value: type: integer description: The usage held. committed: type: - integer - 'null' description: The usage committed, once it is. reference: type: - string - 'null' customData: type: - object - 'null' expiresAt: type: string format: date-time settledAt: type: - string - 'null' format: date-time description: When it was committed, released or expired. createdAt: type: string format: date-time 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 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.