Skip to main content
GET
getInvoices

Headers

Authorization
string<JWT>
required

User API token.

Query Parameters

invoice_id[]
string[]

Array of invoice IDs. Leave empty to get all invoices.

Maximum array length: 100

Invoice identifier, when one exists.

source_id
string

Payment source identifier.

status
enum<string>

Invoice status.

Available options:
pending,
paid,
failed,
chargeback
limit
number

Number of results to return.

offset_id
string

Offet by ID. Used for pagination.

Response

Request was successful.

success
boolean

True when the request succeeded.

response
object[]

Endpoint-specific response payload, or an error message when success is false.