ReferenceBilling

Billing

Your platform billing is read-only over the API. Use these routes with an fdk_ credential and the read:own_billing scope to build a billing view in your own portal or reconcile against your records. Invoices are generated for you on a regular cycle; there is nothing to create or mutate here.

Read routes

MethodPathScopePurpose
GET/v1/merchant/billing/invoicesread:own_billingList your invoices.
GET/v1/merchant/billing/invoices/:idread:own_billingOne invoice with its line items.
GET/v1/merchant/billing/statementread:own_billingYour current outstanding balance.
GET/v1/merchant/recoupread:own_billingRecoup / breakeven status, when configured.

Behavior worth knowing

  • A failed read is never a laundered zero. If the statement balance cannot be determined, the call returns an error — not a $0 you might mistake for “paid up.” Handle the error rather than trusting an empty result.
  • recoup returns config: null when it isn’t set up. That is the honest “not configured” signal on a 200, not an error. Check for it before rendering.
  • Amounts are integer cents. Like everything else in the API — see Money invariants.

Related

  • Tenant-facing API — the full route surface reachable with a credential.
  • Scopes — what read:own_billing grants.
  • Errors — the error envelope these reads return on failure.
SubscriptionsAdd-on marketplace