FurniOpsDocs
API referenceBilling

Read FurniOps AI credit

The organisation's FurniOps AI credit in US dollars (micro-USD): the balance, what running Ask AI turns hold, what expires next, today's allowance and spend, how credit is spent, and whether you may buy more and within which amounts. Today's allowance pays first; credit pays once it is used, when credits_after_allowance is on.

  • Scopesbilling:read
  • Rate classread
GET/v1/billing/credits

The organisation's FurniOps AI credit in US dollars (micro-USD): the balance, what running Ask AI turns hold, what expires next, today's allowance and spend, how credit is spent, and whether you may buy more and within which amounts. Today's allowance pays first; credit pays once it is used, when credits_after_allowance is on.

Authorization

apiKey
AuthorizationBearer <token>

An API key (fo_live_… / fo_test_…) as a bearer token

In: header

Header Parameters

FurniOps-Version?string

Dated API version; pinned per organisation on first use and overridable per request

Value in

  • "2026-10-01"
  • "2026-10-04"
FurniOps-Mode?string

The data the request acts on: test is the organisation's sandbox. An OAuth token picks it (live by default); an API key's mode is fixed, and naming the other one is refused

Value in

  • "live"
  • "test"
If-None-Match?string

ETag of a cached representation; a match returns 304

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/billing/credits"
{  "object": "credit_balance",  "currency": "usd",  "balance_micros": 0,  "held_micros": 0,  "available_micros": 0,  "next_expiry": {    "at": "2019-08-24T14:15:22Z",    "amount_micros": 1  },  "today": {    "allowance_micros": 0,    "allowance_spent_micros": 0,    "credit_spent_micros": 0  },  "settings": {    "credits_after_allowance": true,    "credit_daily_limit_micros": 0,    "low_balance_micros": 0  },  "purchase": {    "currency": "usd",    "minor_per_usd": 1,    "min_minor": 0,    "max_minor": 0,    "max_balance_micros": 0,    "allowed": true,    "refused_reason": "not_owner"  }}

Read billing GET

The organisation's plan, subscription and card, and the plans on sale with their prices. `enabled` is false until selling starts.

Retrieve a credit purchase GET

One purchase. After the browser confirms the payment, poll it until `status` is `succeeded` (the credit is in) or `failed` (pay again with the same purchase).