Skip to main content
GET
/
v1
/
invoices
List invoices
curl --request GET \
  --url https://api.meum.io/v1/invoices \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "external_order_id": "order_demo_1048",
      "amount": "100.00",
      "currency": "USD",
      "order_amount": "100.00",
      "order_currency": "USD",
      "paid_amount": "100.00",
      "output_asset": "USDC",
      "checkout_url": "<string>",
      "return_url": "<string>",
      "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "payment_link_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "transaction_hash": "<string>",
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "paid_at": "2023-11-07T05:31:56Z",
      "expires_at": "2023-11-07T05:31:56Z"
    }
  ],
  "has_more": true,
  "next_cursor": "550e8400-e29b-41d4-a716-446655440000"
}

Authorizations

​
Authorization
string
header
required

Store-scoped API key. Prefix with sk_live_. Example: Authorization: Bearer sk_live_EXAMPLE_DO_NOT_USE

Query Parameters

​
limit
integer
default:20

How many items to return per page (1–100). Defaults to 20 if omitted.

Required range: 1 <= x <= 100
​
starting_after
string

Pagination cursor. Pass the ID of the last item from the previous page to get the next page. Omit on the first request.

Pattern: ^(inv_|txn_|plink_|wh_|whd_|evt_|int_)[0-9a-z]{20,32}$
​
ending_before
string

Reverse pagination. Pass the ID of the first item from the current page to get the previous page. Omit unless paginating backwards.

Pattern: ^(inv_|txn_|plink_|wh_|whd_|evt_|int_)[0-9a-z]{20,32}$
​
status
enum<string>

Show only invoices in this status (e.g. paid, awaiting_payment). Omit to include all statuses. Where the invoice is in the payment flow:

  • pending: created, not yet ready for payment
  • quoted: price quote ready; customer can proceed to pay
  • awaiting_payment: waiting for the customer to send funds
  • paid: payment received and confirmed
  • underpaid: customer paid less than the requested amount
  • expired: not paid before the deadline
  • failed: payment or processing failed
  • refunded: payment was returned to the customer
  • cancelled: invoice was cancelled before completion
Available options:
pending,
quoted,
awaiting_payment,
paid,
underpaid,
expired,
failed,
refunded,
cancelled
​
external_order_id
string

Show only invoices with this order reference (exact match). Omit to skip this filter.

Example:

"order_demo_1048"

​
customer_id
string<uuid>

Show only invoices for this customer ID. Omit to include all customers.

​
payment_link_id
string<uuid>

Show only invoices created from this Pay Link (plink_...). Omit to include all links.

​
created_after
string<date-time>

Only invoices created on or after this time (UTC, e.g. 2025-01-01T00:00:00.000Z). Omit for no lower bound.

​
created_before
string<date-time>

Only invoices created before this time (UTC). Omit for no upper bound.

​
paid_after
string<date-time>

Only invoices paid on or after this time (UTC). Omit for no lower bound.

​
paid_before
string<date-time>

Only invoices paid before this time (UTC). Omit for no upper bound.

Response

Paginated invoice list

​
data
object[]
required

Page of resources for the current request.

​
has_more
boolean
required

Whether additional pages exist after this one.

Example:

true

​
next_cursor
string<uuid> | null
required

Pass as starting_after on the next request to fetch the following page. Null when has_more is false.

Example:

"550e8400-e29b-41d4-a716-446655440000"