Retrieve an entity invoice explainer

get

https://api.doit.com/billing/v1/billing-profiles/{billingProfileId}/billing-explainers/{invoiceNumber}

Returns invoiced cost changes for an invoice owned by the specified billing profile in the authenticated tenant.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

billingProfileId

string

required

^[A-Za-z0-9_-]{1,128}$

Billing profile identifier shown on the invoice.

invoiceNumber

string

required

^[A-Za-z0-9_-]{1,64}$

Customer-facing invoice number.

Headers

X-Tenant-Id

string

Tenant (customer) identifier that conveys the tenant scope for the request
(DoiT API Design Standards §15).

Resolution when the header is absent:

A key scoped to exactly one tenant resolves to that tenant automatically; the header is
optional.
A principal that can access more than one tenant (e.g. DoiT-employee keys) must supply the
header. Without it the request is rejected with 400 and code tenant_id_required — the
server does not guess across tenant scopes.

When the header is present but conflicts with the tenant the key is scoped to, the request is
rejected with 400 and code tenant_id_mismatch.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200Billing explainer returned.