List all invoices
GET {{baseUrl}}/v1/invoices
You can list all invoices, or list the invoices for a specific customer. The invoices are returned sorted by creation date, with the most recently created invoices appearing first.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
collection_method | string | The collection method of the invoice to retrieve. Either charge_automatically or send_invoice . | |
created[gt] | string | ||
created[gte] | string | ||
created[lt] | string | ||
created[lte] | string | ||
customer | string | Only return invoices for the customer specified by this customer ID. | |
due_date[gt] | string | ||
due_date[gte] | string | ||
due_date[lt] | string | ||
due_date[lte] | string | ||
ending_before | string | A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar , your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. | |
expand[0] | string | Specifies which fields in the response should be expanded. | |
expand[1] | string | Specifies which fields in the response should be expanded. | |
limit | string | A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. | |
starting_after | string | A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo , your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. | |
status | string | The status of the invoice, one of draft , open , paid , uncollectible , or void . Learn more | |
subscription | string | Only return invoices for the subscription specified by this subscription ID. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string |