Sign in

v4

latestOpenAPI 3.0.02026-07-12228151.6 MB

List all 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.

get/v1/invoices

Query parameters

collection_method'charge_automatically' | 'send_invoice'

The collection method of the invoice to retrieve. Either charge_automatically or send_invoice.

OR
integer

Only return invoices that were created during the given date interval.

customerstring

Only return invoices for the customer specified by this customer ID.

customer_accountstring

Only return invoices for the account representing the customer specified by this account ID.

OR
integer
ending_beforestring

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.

expandstring[]

Specifies which fields in the response should be expanded.

limitinteger

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

starting_afterstring

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'draft' | 'open' | 'paid' | 'uncollectible' | 'void'

The status of the invoice, one of draft, open, paid, uncollectible, or void. Learn more

subscriptionstring

Only return invoices for the subscription specified by this subscription ID.

Response

Successful response.

has_moreboolean required

True if this list has another page of items after this one that can be fetched.

object'list' required

String representing the object's type. Objects of the same type share the same value. Always has the value list.

urlstring required

The URL where this list can be accessed.