Billing
Your billing accounts, invoices and credit notes, and the services you contracted.
The billing endpoints return the companies you are invoiced as, the invoices and credit notes issued to them, and the services you contracted. They need the billing:read scope.
| Endpoint | Route | Scope |
|---|---|---|
| List billing accounts | GET /v1/billing/accounts |
billing:read |
| One billing account | GET /v1/billing/accounts/{account_id} |
billing:read |
| List invoices | GET /v1/billing/invoices |
billing:read |
| One invoice | GET /v1/billing/invoices/{invoice_id} |
billing:read |
| List services | GET /v1/billing/services |
billing:read |
Billing belongs to the whole customer: a key limited to some venues gets 403 insufficient_scope. Every list takes limit (1 to 100, default 50), cursor and customer_id. In the examples, $BASE is https://api.bookline.ai/v1 and $BOOKLINE_API_KEY is your key, as in the quick start.
Billing accounts
Section titled “Billing accounts”GET /v1/billing/accounts returns the companies your account is invoiced as; GET /v1/billing/accounts/{account_id} one of them.
| Field | What it is |
|---|---|
id |
The billing account’s identifier |
legal_name |
The company name printed on its invoices |
legal_id |
The company’s tax id, as printed on its invoices |
country |
The country of the billing address, e.g. SPAIN, MEXICO |
notification_language |
The language of invoices and payment notices, e.g. SPANISH, ENGLISH; null when none was chosen |
created_at |
When it was created |
Invoices
Section titled “Invoices”GET /v1/billing/invoices returns the invoices and credit notes issued to your billing accounts, newest first. Add account_id to get one billing account’s only. GET /v1/billing/invoices/{invoice_id} returns one.
curl -s -H "apikey: $BOOKLINE_API_KEY" "$BASE/billing/invoices?account_id=<account_id>"{ "data": [ { "id": "…", "account_id": "…", "number": "F2026-0153", "type": "invoice", "currency": "EUR", "issued_on": "2026-11-01", "due_on": "2026-11-15", "status": "OPEN", "subtotal_cents": 19900, "tax_cents": 4179, "total_cents": 24079, "rectifies": null } ], "meta": { "limit": 50, "next_cursor": null }}| Field | What it is |
|---|---|
id |
The invoice’s identifier |
account_id |
The billing account it is issued to |
number |
The invoice number |
type |
invoice, or credit_note for a correction of another invoice |
currency |
ISO 4217 code of every amount, e.g. EUR |
issued_on, due_on |
Issue and due dates |
status |
OPEN, PAID or VOID |
subtotal_cents, tax_cents, total_cents |
Before taxes, taxes and total, in minor units of currency (see below) |
rectifies |
A credit note’s: the id of the invoice it corrects |
- Amounts are in minor units. They follow the currency’s ISO 4217 exponent: cents for EUR, MXN or COP (
24079is 240.79 €), whole units for CLP or PYG. Never divide a CLP or PYG amount by 100. - Credit notes. A credit note that cancels an invoice in full makes both
VOID. A partial one leaves the invoice at its full total: subtract the credit note’s total from the invoice itrectifies. - Draft invoices are not listed.
Services
Section titled “Services”GET /v1/billing/services returns the services you contracted: what each covers, its status today and its billing account.
| Field | What it is |
|---|---|
id |
The service’s identifier |
account_id |
The billing account it is invoiced to; null until one is assigned |
type |
VOICE_ASSISTANT, WHATSAPP_BOT, PBX, MESSAGES, CRM_MARKETING or OTHER |
status |
DRAFT, TRIAL, ENROLLED, EXEMPT, OFF_SEASON, SCHEDULED, PAUSED, CANCELLED or TRIAL_ENDED |
currency |
ISO 4217 code it is priced in |
venue_id, venue_group_id, agent_id |
The venue, venue group or agent it covers, if one |
started_at |
When it went live |
ended_at |
When it was terminated, if it was |
Data rules
Section titled “Data rules”- Only the fields on this page. Payment methods, prices and discounts are not part of the API.
- Read only. Billing details are changed in the portal.
Related
Section titled “Related”- Billing: billing in the portal.
- Errors and rate limits.
