List Invoices
List Invoices
Authorizations
Bearer API Key authentication. Format: Authorization: Bearer {your_api_key}
Headers
The unique identifier of the request
Query Parameters
Invoice ID array, filter invoices whose IDs belong to this array
Trade ID array, filter invoices whose Trade IDs belong to this array
Order ID array, filter invoices whose Order IDs belong to this array
Subscription ID
Customer ID
Invoice status array, filter invoices whose status belong to this array
- open: Initial state
- pending: Invoice pending
- retrying: Invoice retrying
- success: Invoice successful
- failed: Invoice failed
- refunded: Invoice fully refunded
- partially_refunded: Invoice partially refunded
Invoice type array, filter invoices whose type belong to this array
- initial: First payment
- trial: Trial period
- renewal: Renewal
- refund: Refund
Cursor for pagination. starting_after is the object ID that defines your position in the list. For example, if you want to get the next page, you can use the last object's ID as the parameter value after getting the object list for the first time. Cannot be used together with ending_before
Cursor for pagination. ending_before is the object ID that defines your position in the list. For example, if you want to get the previous page, you can use the first object's ID as the parameter value after getting the object list for the first time. Cannot be used together with starting_after
Pagination parameter, number of items per page, default: 10, interface defaults to sorting by creation time in descending order. Limit: [1, 100]
Minimum value to filter by (exclusive, UTC time in RFC3339 format, such as '2025-01-01T00:00:00Z')
Minimum value to filter by (inclusive, UTC time in RFC3339 format, such as '2025-01-01T00:00:00Z')
Maximum value to filter by (exclusive, UTC time in RFC3339 format, such as '2025-01-01T00:00:00Z')
Maximum value to filter by (inclusive, UTC time in RFC3339 format, such as '2025-01-01T00:00:00Z')