GET
/
invoices
List invoices
curl --request GET \
  --url https://api.paygentic.io/v0/invoices \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "object": "invoice",
      "subscriptionId": "<string>",
      "merchantId": "<string>",
      "customerId": "<string>",
      "amount": 123,
      "currency": "<string>",
      "status": "pending",
      "invoiceNumber": "<string>",
      "description": "<string>",
      "metadata": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "paidAt": "2023-11-07T05:31:56Z",
      "transactionId": "<string>"
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

subscriptionId
string

Filter invoices for a specific subscription

merchantId
string

Filter invoices for a specific merchant

customerId
string

Filter invoices for a specific customer

status
enum<string>

Filter by invoice status

Available options:
pending,
paid,
cancelled
page
integer
default:1

Page number

Required range: x >= 1
limit
integer
default:20

Number of invoices to return

Required range: 1 <= x <= 100

Response

200
application/json

List of invoices

The response is of type object.