Skip to main content
GET
Get invoice

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

invoiceId
string
required

The ID of the invoice.

Example:

"inv_mqxd1kc6bgtcc676xoqzax47"

Query Parameters

expand
string

Comma-separated list of relations to expand. Allowed values: contract, contract.client, contract.clientAddress, contract.tenantAddress.

Example:

"contract,contract.client,contract.clientAddress,contract.tenantAddress"

Response

Default Response

Standard success response payload wrapped in a data property.

data
object
required

Invoice resource returned by the API.