FurniOpsDocs
API referenceBilling

Preview a credit purchase

What buying the amount would cost now, with tax from Stripe Tax and the credit it adds. Changes nothing. Owner only. While billing is switched off, it answers 409 conflict.

POST/v1/billing/credits/purchases/preview

What buying the amount would cost now, with tax from Stripe Tax and the credit it adds. Changes nothing. Owner only. While billing is switched off, it answers 409 conflict.

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"
Idempotency-Key*string

Unique key for this operation, reused on retries (24 h)

Length1 <= length <= 257
FurniOps-Dry-Run?string

Preview the write and change nothing: true answers the would-be response, explain a Preview (application/vnd.furniops.preview+json)

Value in

  • "true"
  • "explain"

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Credit to buy

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

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/v1/billing/credits/purchases/preview" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "amount": {      "amount": 1,      "currency": "usd"    }  }'
{  "object": "credit_purchase_preview",  "amount": {    "amount": -9007199254740991,    "currency": "usd"  },  "tax": {    "amount": -9007199254740991,    "currency": "usd"  },  "total": {    "amount": -9007199254740991,    "currency": "usd"  },  "credit_micros": 1,  "tax_status": "complete"}

List the plans on sale GET

The listed, active plans in order, with what each grants and its monthly and annual prices; Enterprise has none (contact sales). Public and cached: the pricing page renders from it. Retailers' plans unless `kind=vendor`.

Preview a subscription POST

What subscribing to, or moving to, the plan and interval would cost now: fee, discount, tax and total, calculated by Stripe Tax from the address (without one, before tax), when it takes effect and what is charged today. An invalid promotion code is reported in `promotion`, not refused. Changes nothing. While billing is switched off, it answers 409 `conflict`.