Sign inGet Started

List wallets

GET
/v1/organization/billing/wallets
// Use a delegated user OAuth token with org:billing:read in its issuing region.
const bird = new BirdClient({ apiKey: process.env.BIRD_OAUTH_ACCESS_TOKEN!, region: "eu1" });
await bird.billingWallets.list();
Response200
{
  "data": [
    {
      "id": "wal_01krdgeqcxet5s7t44vh8rt9mg",
      "currency_code": "USD",
      "balance": "118.00",
      "settled_balance": "150.00",
      "renewal_reserved": "25.00",
      "renewal_required": "30.00",
      "collection_status": "none",
      "collection_renewal": "30.004",
      "collection_required": "42.00",
      "collection_usage_buffer": "10.00",
      "collection_deficit": "2.00",
      "credit_limit": "0.00"
    }
  ]
}

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.

Response Payload

data
array of object
required
Show child attributes

Continue with the documentation, guides and examples for this topic.