List invoices | Prolifi | Documentation

curl https://api.prolifi.co/api/v1/public/invoices \
     -H "Authorization: Bearer <token>"

{
  "data": [
    {
      "id": "string",
      "invoice_number": "string",
      "customer_id": "string",
      "subscription_id": "string",
      "status": "pending",
      "due_date": "2023-01-15",
      "issue_date": "2023-01-15",
      "subtotal": 1.1,
      "tax": 1.1,
      "total": 1.1,
      "amount_paid": 1.1,
      "amount_due": 1.1,
      "currency": "string",
      "line_items": [
        {
          "id": "string",
          "description": "string",
          "quantity": 1.1,
          "unit_price": 1.1,
          "amount": 1.1
        }
      ],
      "metadata": {},
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-01-15T09:30:00Z"
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 1,
    "offset": 1,
    "has_more": true
  }
}

Returns a paginated list of invoices. Supports filtering by customer, status, and subscription.

Authentication

AuthorizationBearer

Use a secret key (sk_test_* or sk_live_*) for full read/write access, or a public key (pk_test_* or pk_live_*) for read-only access.

Query parameters

limitintegerOptional1-100Defaults to 20

Maximum number of items to return (1-100).

offsetintegerOptional>=0Defaults to 0

Number of items to skip before returning results.

customer_idstringOptionalformat: "uuid"

Filter by customer UUID.

statusenumOptional

Filter by invoice status.

subscription_idstringOptionalformat: "uuid"

Filter by subscription UUID.

Response

A paginated list of invoices

datalist of objects

paginationobject

Errors

401

Unauthorized Error