GetbeelDocs

This month's SDI usage and plan

Live SDI transactions, sent and received, one per document (the sandbox and documents collected from email are not counted), the plan, and on the pay-per-use rate card (new accounts: sends €0.10 / €0.06 / €0.035 with the first 10 a month free; receiving from SDI €0.10 per invoice) the free allowance and the estimated amounts, sent and received separately. A client company (Getbeel-Company) is billed to its parent: it sees its own transactions and billed_to; the parent sees the total and the split per company.

GET
/usage

Live SDI transactions, sent and received, one per document (the sandbox and documents collected from email are not counted), the plan, and on the pay-per-use rate card (new accounts: sends €0.10 / €0.06 / €0.035 with the first 10 a month free; receiving from SDI €0.10 per invoice) the free allowance and the estimated amounts, sent and received separately. A client company (Getbeel-Company) is billed to its parent: it sees its own transactions and billed_to; the parent sees the total and the split per company.

Authorization

apiKey
headerAuthorizationBearer <token>

API key: gb_test_… or gb_live_…

Query Parameters

period?string

Month (UTC), default the current one

Match^\d{4}-(0[1-9]|1[0-2])$

Header Parameters

Getbeel-Company?string

Act on one of the account's client companies (its id from GET /companies) instead of the key's own account. 404 company_not_found when the key cannot act on it.

Formatuuid

Response Body

OK

application/json
  1. response
object*string
account_id*string

The account the request acts on (the key's, or the Getbeel-Company)

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
billed_to*string

The account that pays: the parent for a client company, else account_id

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
period*string
plan*string

rate_card: pay per live SDI transaction, sent and received priced separately (new accounts). sdi_addon: a fixed monthly SDI tier (existing customers). none: sandbox only; live sends answer 402 until a plan is picked in Settings → Usage & billing

Value in"rate_card""sdi_addon""none"
rate_card_available*boolean

No plan yet, but the pay-per-use rate card (with its free tier) can be picked

sdi_transactions*

Live SDI transactions this month: sent (invoices and self-invoices sent to SDI) and received (invoices received from SDI), one per document. The sandbox and documents collected from email are not counted. On a client company: its own only

free_allowance*|

Free live SDI sends a month on the rate card; received invoices have no free allowance (null otherwise and on client companies)

estimated_amount*|

Rate card cost of the month so far (sent, received and email extraction), ex VAT (null without the rate card and on client companies)

email_extractions*integer

Documents the mailbox scan extracted and saved this month at the metered email price (rate card accounts without a plan; plan accounts use invoice credits)

Range-9007199254740991 <= value <= 9007199254740991
estimated_amounts*|

The estimated amount split: sent (graduated tiers), received (flat price) and email extraction (flat price), ex VAT (null like estimated_amount)

currency*string
rate_card*array<>

Graduated tiers per SENT transaction and month on the card this account pays (existing rate cards keep their price); up_to is inclusive, null = no limit

received_unit_amount*string

Flat price per invoice RECEIVED from SDI on the card this account pays (no free allowance, no tiers)

Match^\d+\.\d{3}$
email_extraction_unit_amount*string

Flat price per document extracted by the mailbox scan on the rate card (no free allowance)

Match^\d+\.\d{3}$
quota*|

Fixed SDI add-on tier: sends allowed and used this month (shared by the parent and its client companies)

companies*array<>

Per client company billed to this account (empty on a client company)

Example Request
curl -X GET 'https://www.getbeel.com/api/v1/usage'
Example Response
{  "object": "usage",  "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",  "billed_to": "4c2bff73-628d-40b7-b454-16c2b7f0d31c",  "period": "2026-10",  "plan": "rate_card",  "rate_card_available": true,  "sdi_transactions": {    "sent": -9007199254740991,    "received": -9007199254740991,    "total": -9007199254740991  },  "free_allowance": {    "included": -9007199254740991,    "used": -9007199254740991,    "remaining": -9007199254740991  },  "estimated_amount": "122.00",  "email_extractions": -9007199254740991,  "estimated_amounts": {    "sent": "122.00",    "received": "122.00",    "email_extraction": "122.00",    "total": "122.00"  },  "currency": "EUR",  "rate_card": [    {      "up_to": -9007199254740991,      "unit_amount": "0.200"    }  ],  "received_unit_amount": "0.180",  "email_extraction_unit_amount": "0.060",  "quota": {    "limit": -9007199254740991,    "used": -9007199254740991,    "remaining": -9007199254740991  },  "companies": [    {      "sent": -9007199254740991,      "received": -9007199254740991,      "total": -9007199254740991,      "company_id": "b2e6a1c3-1a5e-44ae-a8fd-81f76fd715cf"    }  ]}