Partner reports: billing

What you're being charged and why: by account, by location, and in total.

What you're being charged and why: by account, by location, and in total.

You'll need a partner token.

Prerequisites

  • A bearer token in the Authorization header. Any endpoint that needs no token says so on its own page.
  • The id of each record the call targets. Every endpoint page lists the ids it needs.

Errors

StatusMeaning
401The bearer token is missing, expired or invalid
403The token is valid but the record sits outside your account
422The request failed validation — the response names the fields
500Unexpected server error

Individual endpoints may return more; each page lists its own.

Endpoints

Billing summary

GET — Get the current period's charges in brief: total, active locations, and any overage.

Open →

Billing detail

GET — Get the full billing picture: every account and location with its plan, charges, usage, and overage.

Open →

Billing for one account

GET — Get an account's charges for the period, by location.

Open →

Billing for one location

GET — Get a location's charges for the period, by capability.

Open →


Did this page help you?