Invoices
Invoice management operations
Create
Create Batch Get
List
List History
Retrieve
Search
Update
ModelsExpand Collapse
Invoice object { id, created, status, 5 more } Invoice object.
Invoice object.
line_items: optional array of object { id, amount, currency_code, 6 more } Line items for the invoice.
Line items for the invoice.
Total amount as a string in the smallest currency unit, such as cents for USD. Deprecated, use price.amount instead.
currency_code: "ADA" or "BTC" or "DAI" or 176 moreISO 4217 or crypto currency code.
ISO 4217 or crypto currency code.
InvoiceCreateResponse object { data }
Invoice object.
Invoice object.
line_items: optional array of object { id, amount, currency_code, 6 more } Line items for the invoice.
Line items for the invoice.
Total amount as a string in the smallest currency unit, such as cents for USD. Deprecated, use price.amount instead.
currency_code: "ADA" or "BTC" or "DAI" or 176 moreISO 4217 or crypto currency code.
ISO 4217 or crypto currency code.
InvoiceCreateBatchGetResponse object { data } Result of a batch invoice retrieval.
Result of a batch invoice retrieval.
data: object { invoices, not_found } Result of a batch invoice retrieval.
Result of a batch invoice retrieval.
Invoices that were found, in request order.
Invoices that were found, in request order.
balances: array of object { currency, net, payins, payouts } Invoice-level balances by currency.
Invoice-level balances by currency.
payments: array of object { amount, currency, posted, 3 more } Payments allocated to the invoice.
Payments allocated to the invoice.
users: array of object { id, balances, external_id } Users involved in the invoice.
Users involved in the invoice.
balances: array of object { currency, net, payins, payouts } Per-currency balance breakdown for the user.
Per-currency balance breakdown for the user.
InvoiceListResponse object { data }
List of invoices.
List of invoices.
line_items: optional array of object { id, amount, currency_code, 6 more } Line items for the invoice.
Line items for the invoice.
Total amount as a string in the smallest currency unit, such as cents for USD. Deprecated, use price.amount instead.
currency_code: "ADA" or "BTC" or "DAI" or 176 moreISO 4217 or crypto currency code.
ISO 4217 or crypto currency code.
InvoiceListHistoryResponse object { data }
Version history of the invoice.
Version history of the invoice.
line_items: optional array of object { id, amount, currency_code, 6 more } Line items for the invoice.
Line items for the invoice.
Total amount as a string in the smallest currency unit, such as cents for USD. Deprecated, use price.amount instead.
currency_code: "ADA" or "BTC" or "DAI" or 176 moreISO 4217 or crypto currency code.
ISO 4217 or crypto currency code.
InvoiceRetrieveResponse object { data }
Invoice with balance details.
Invoice with balance details.
balances: array of object { currency, net, payins, payouts } Invoice-level balances by currency.
Invoice-level balances by currency.
payments: array of object { amount, currency, posted, 3 more } Payments allocated to the invoice.
Payments allocated to the invoice.
users: array of object { id, balances, external_id } Users involved in the invoice.
Users involved in the invoice.
balances: array of object { currency, net, payins, payouts } Per-currency balance breakdown for the user.
Per-currency balance breakdown for the user.
InvoiceSearchResponse object { data } Search results for invoices.
Search results for invoices.
data: object { invoices, page_info } Search results for invoices.
Search results for invoices.
Invoices matching the search criteria.
Invoices matching the search criteria.
balances: array of object { currency, net, payins, payouts } Invoice-level balances by currency.
Invoice-level balances by currency.
payments: array of object { amount, currency, posted, 3 more } Payments allocated to the invoice.
Payments allocated to the invoice.
users: array of object { id, balances, external_id } Users involved in the invoice.
Users involved in the invoice.
balances: array of object { currency, net, payins, payouts } Per-currency balance breakdown for the user.
Per-currency balance breakdown for the user.
InvoiceUpdateResponse object { data }
Invoice object.
Invoice object.
line_items: optional array of object { id, amount, currency_code, 6 more } Line items for the invoice.
Line items for the invoice.
Total amount as a string in the smallest currency unit, such as cents for USD. Deprecated, use price.amount instead.
currency_code: "ADA" or "BTC" or "DAI" or 176 moreISO 4217 or crypto currency code.
ISO 4217 or crypto currency code.