Open Menace Voice

Get Billing Credits

GET /api/v1/organizations/billing/credits — request parameters and responses from the Menace Voice API schema.

2 min read

get/api/v1/organizations/billing/credits

Request example

curl --request GET \
  --url https://voice.menaceui.com/api/v1/organizations/billing/credits \
  --header 'authorization: <string>' \
  --header 'X-API-Key: <string>'

Response

{
  "total_credits_used": 0,
  "remaining_credits": 0,
  "total_quota": 0,
  "account": {
    "id": 1,
    "organization_id": 1,
    "billing_mode": "<string>",
    "cached_balance_credits": 1,
    "currency": "<string>"
  },
  "ledger_entries": [
    {
      "id": 1,
      "entry_type": "<string>",
      "origin": "<string>",
      "credits_delta": 1,
      "balance_after": 1,
      "amount_minor": 1,
      "amount_currency": "<string>",
      "payment_order_id": 1,
      "metric_code": "<string>",
      "correlation_id": "<string>",
      "aggregation_key": "<string>",
      "usage_event_id": 1,
      "workflow_run_id": 1,
      "workflow_id": 1,
      "billable_quantity": 1,
      "quantity_unit": "<string>",
      "metadata": {},
      "created_at": "<string>"
    }
  ],
  "total_count": 0,
  "page": 1,
  "limit": 50,
  "total_pages": 0
}

get/api/v1/organizations/billing/credits

See authentication for workspace API access. Public embed and artifact endpoints use their documented session or access tokens.

Query parameters

pageinteger#

Default: 1

Range: >= 1

limitinteger#

Default: 50

Range: 1–100

Headers

authorizationstring · null#

X-API-Keystring · null#

Responses

application/json

Successful Response

total_credits_usednumber#

Default: 0

remaining_creditsnumber#

Default: 0

total_quotanumber#

Default: 0

accountobject · null#

Show child attributes

ledger_entriesobject[]#

Show child attributes

idintegerrequired#

entry_typestringrequired#

originstring · null#

Show child attributes

credits_deltanumberrequired#

balance_afternumberrequired#

amount_minorinteger · null#

Show child attributes

amount_currencystring · null#

Show child attributes

payment_order_idinteger · null#

Show child attributes

metric_codestring · null#

Show child attributes

correlation_idstring · null#

Show child attributes

aggregation_keystring · null#

Show child attributes

usage_event_idinteger · null#

Show child attributes

workflow_run_idinteger · null#

Show child attributes

workflow_idinteger · null#

Show child attributes

billable_quantitynumber · null#

Show child attributes

quantity_unitstring · null#

Show child attributes

metadataobject#

created_atstringrequired#

total_countinteger#

Default: 0

pageinteger#

Default: 1

limitinteger#

Default: 50

total_pagesinteger#

Default: 0

Get Current Period Usage Create Mps Credit Purchase Url