billing

List wallets

Changed on

Returns all wallets for the organization. A wallet is created automatically with the organization and pays usage charges. Amounts are decimal strings in currency_code; balance is the amount currently available to spend, excluding additional credit_limit headroom. Requires a delegated user OAuth token with org:billing:read; workspace and organization master API keys are refused with 403.

get/v1/organization/billing/wallets

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/organization/billing/wallets
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Headers

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Response

The wallets.

Example response

{
  "data": [
    {
      "id": "wal_01krdgeqcxet5s7t44vh8rt9mg",
      "currency_code": "EUR",
      "balance": "118.00",
      "settled_balance": "150.00",
      "renewal_reserved": "25.00",
      "renewal_required": "30.00",
      "collection_renewal": "30.004",
      "collection_required": "42.00",
      "collection_usage_buffer": "10.00",
      "collection_deficit": "2.00",
      "credit_limit": "0.00"
    }
  ]
}

Changes