Skip to main content
GET
/
lps
/
invoices
List invoices
curl --request GET \
  --url https://api.cheqpay.dev/lps/invoices \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "_id": "<string>",
      "customerId": "<string>",
      "merchantId": "<string>",
      "paymentOrderId": "<string>",
      "paymentLinkId": "<string>",
      "reference": "<string>",
      "orderNumber": "<string>",
      "products": [
        {
          "_id": "<string>",
          "merchantId": "<string>",
          "name": "<string>",
          "price": 1,
          "id": "<string>",
          "description": "<string>",
          "status": "active",
          "imageUrl": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "totals": {
        "total": 123,
        "taxes": 123,
        "shipping": 123,
        "fees": 123,
        "discounts": 123
      },
      "billingAddress": {
        "firstName": "<string>",
        "lastName": "<string>",
        "organizationName": "<string>",
        "email": "[email protected]",
        "phone": "<string>",
        "addressLine1": "<string>",
        "addressLine2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postalCode": "<string>",
        "country": "<string>",
        "isSameAsShipping": true
      },
      "shippingAddress": {
        "firstName": "<string>",
        "lastName": "<string>",
        "organizationName": "<string>",
        "email": "[email protected]",
        "phone": "<string>",
        "addressLine1": "<string>",
        "addressLine2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postalCode": "<string>",
        "country": "<string>"
      },
      "paymentMethod": {
        "type": "card",
        "card": {
          "bin": "<string>",
          "brand": "<string>",
          "country": "<string>",
          "expiryMonth": "<string>",
          "expiryYear": "<string>",
          "issuerBank": "<string>",
          "last4": "<string>",
          "type": "<string>"
        }
      },
      "status": "pending",
      "metadata": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "currentPage": 1,
  "totalPages": 5,
  "totalCount": 47,
  "limit": 10
}

Authorizations

​
x-api-key
string
header
required

API key for merchant authentication

Query Parameters

​
page
integer
default:1

Page number (1-indexed)

Required range: x >= 1
​
limit
integer
default:10

Number of items per page

Required range: 1 <= x <= 100
​
status
enum<string>

Filter by invoice status

Available options:
pending,
paid,
cancelled,
refunded,
failed
​
dateFrom
string<date-time>

Filter invoices created from this date. Must be in ISO 8601 datetime format (e.g., 2024-01-15T10:30:00Z)

​
dateTo
string<date-time>

Filter invoices created until this date. Must be in ISO 8601 datetime format (e.g., 2024-01-15T10:30:00Z)

​
sort
enum<string>
default:createdAt

Field to sort results by. Currently supports: createdAt

Available options:
createdAt
​
order
enum<string>
default:desc

Sort order: asc for ascending or desc for descending

Available options:
asc,
desc

Response

Invoices retrieved successfully

Paginated response containing invoices

​
data
object[]

Array of invoice objects. The metadata field is excluded from list responses.

​
currentPage
integer

Current page number

Example:

1

​
totalPages
integer

Total number of pages

Example:

5

​
totalCount
integer

Total number of invoices matching the filter

Example:

47

​
limit
integer

Number of items per page

Example:

10