List invoices
Returns a list of invoices, optionally filtered by a related resource (customer, subscription, or voucher), currency, or status.
Headers
string The Bearer token for authentication.
string The user agent of the request. Must contain at least two identifiers separated by a space.
string The content type of the request.
Parameters
string The ID of the resource you want to filter based on. (e.g. Customer, Subscription or Voucher ID's)
string The currency you want to filter based on.
string The status you want to filter based on.
draftunpaidpaidvoidnumber The number of items to return.
string The start date to filter based on.
string The end date to filter based on.
Response Body
application/jsonboolean Indicates that the request was successful.
object The invoices data.
array The list of invoices.
string The ID of the invoice.
number The Serial ID of the invoice.
string The ID of the subscription the invoice is associated with.
object The customer details.
string The ID of the customer.
string The name of the customer.
string The email of the customer.
object Customer billing details.
string Address line 1.
string Address line 2.
string City.
string State.
string Zip code.
string Country code in ISO 3166-1 alpha-2 format.
object Customer shipping details schema.
string Full name of the customer.
string Phone number of the customer. (e.g. +597-8123456)
string Address line 1.
string Address line 2.
string City.
string State.
string Zip code.
string Country code in ISO 3166-1 alpha-2 format.
object The details of the voucher applied to the invoice.
string The ID of the voucher.
number The rate of the voucher.
string The summary of the invoice.
object The amount details of the invoice.
float The sub total of the invoice.
float The discount total of the invoice.
float The net total of the invoice.
string Status of the invoice.
draftunpaidpaidvoidstring The currency of the invoice.
object The session details for collecting payment
string The checkout url
date-time Session expiration time.
date-time The due date of the invoice.
date-time The date and time the invoice was paid.
date-time The date and time the invoice was voided.
date-time The date and time the invoice was created.