Accounts

Get your provisioning usage

Returns how many accounts you have provisioned and the billable count that follows from them — the figure behind your offline B2B invoice.

  • Billable unit: the provisioned account, not the real NIF. Every account you provision counts as one, empty and unclaimed ones included.
  • account_id: your own account. Usage is a property of the provisioner, not of each provisioned account, so any other id returns 404.
  • Entitlement: requires manage_accounts.
get/v1/accounts/{account_id}/usage

Request

  • Base URL: https://app.beel.es/api
  • URL: https://app.beel.es/api/v1/accounts/{account_id}/usage
  • Auth: HTTP bearer

Path parameters

account_idstring uuid required

Your own account id.

Response

Provisioning usage of the caller

successboolean required

Example response

{
  "success": true,
  "data": {
    "provisioned_accounts": 1000,
    "nifs": 1000
  },
  "meta": {
    "timestamp": "2025-01-15T10:30:00Z",
    "request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.