Skip to main content
GET
/
api
/
v1
/
invoices
List Invoices
curl --request GET \
  --url https://api.example.com/api/v1/invoices \
  --header 'x-api-key: <x-api-key>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customer_email": "<string>",
    "amount": 123,
    "currency": "<string>",
    "status": "<string>",
    "due_date": "2023-11-07T05:31:56Z",
    "paid_at": "2023-11-07T05:31:56Z",
    "refund_amount": 123,
    "refund_status": "<string>",
    "refund_reason": "<string>",
    "created_at": "2023-11-07T05:31:56Z"
  }
]

Headers

x-api-key
string
required

Response

Successful Response

id
string<uuid>
required
customer_email
string
required
amount
number
required
currency
string
required
status
string
required
due_date
string<date-time>
required
paid_at
string<date-time> | null
required
refund_amount
number
required
refund_status
string
required
refund_reason
string | null
required
created_at
string<date-time>
required