List invoices

get

https://www.pelcro.com/api/v1/core/invoices

Retrieve a paginated list of invoices.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

site_id

int32

required

The unique identifier of the site associated with your account.

customer_id

integer

Filter invoices by customer user ID.

status

string

enum

Filter by invoice status.

Allowed:

limit

int32

Defaults to 10

The maximum number of objects you want returned per result set. For instance, if you set limit=10, the API will return a maximum of 10 objects in the response. (max: 100)

page

int32

Defaults to 1

The specific page of the result set you want to retrieve, typically used in conjunction with limit. For example, if you set page=2 and limit=10, the API will return the second page of results, containing a maximum of 10 objects starting from the 11th object.

sort

string

enum

One supported attribute to sort on. Prefix with - for descending.

Allowed:

expand

string

An optional comma separated list of supported relationships to expand. This endpoint supports expanding user, subscription, charge and discount relationships.

filter[id]

string

Filter by invoice ID. Example: eq:42

filter[user_id]

string

Filter by customer ID. Example: eq:12345

filter[status]

string

enum

Filter by invoice status.

Allowed:

filter[metadata.*]

string

Filter by metadata key. Operators: eq, has. Example: filter[metadata.key]=eq:value

Headers

Authorization

string

required

Defaults to Bearer eyJ***

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success.

400Invalid request.

401Unauthenticated.