RevKeen Docs
Api reference

List orders

List all orders for the authenticated merchant. Supports filtering and cursor-based pagination.

Related endpoints

  • POST /orders — Create an order
  • GET /orders/{id} — Retrieve an order
  • PATCH /orders/{id} — Update an order
  • POST /orders/{id}/pay — Pay for an order
  • POST /orders/{id}/cancel — Cancel an order
  • POST /orders/{id}/fulfill — Fulfill an order

Common errors

  • 401 unauthenticated — missing, malformed, or revoked API key.

Pagination

Offset-based with limit (default 25, max 100) and offset. The response pagination block includes total and hasMore. See the pagination guide for SDK auto-paging helpers.

GET
/orders

Authorization

x-api-key<token>

Your RevKeen API key (powered by Unkey). Get it from Dashboard > Settings > API Keys. Use rk_sandbox_* for test mode and rk_live_* for production.

In: header

Query Parameters

customer_id?string

Filter by customer ID

Formatuuid
status?string

Filter by status

Value in"draft" | "pending" | "paid" | "partially_paid" | "refunded" | "canceled" | "fulfilled"
billing_type?string

Filter by billing type

Value in"one_time" | "recurring"
created_gte?|

Filter by created_at >= (Unix timestamp)

created_lte?|

Filter by created_at <= (Unix timestamp)

limit?integer

Maximum number of results (1-100)

Default20
Range1 <= value <= 100
starting_after?string

Cursor for pagination - return results after this ID

Formatuuid
ending_before?string

Cursor for pagination - return results before this ID

Formatuuid

Response Body

application/json

application/json

curl "https://api.revkeen.com/v2/orders" \  -H "x-api-key: $REVKEEN_API_KEY"
{
  "object": "list",
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "object": "order",
      "public_id": "string",
      "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
      "status": "draft",
      "billing_type": "one_time",
      "fulfillment_status": "unfulfilled",
      "currency": "string",
      "subtotal": 0,
      "discount": 0,
      "tax": 0,
      "total": 0,
      "amount_paid": 0,
      "amount_refunded": 0,
      "amount_due": 0,
      "line_items": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
          "description": "string",
          "quantity": 1,
          "unit_price": 0,
          "subtotal": 0,
          "discount": 0,
          "tax": 0,
          "total": 0,
          "metadata": {},
          "position": 0
        }
      ],
      "metadata": {},
      "notes": "string",
      "invoice_id": "f4c4edb8-11e0-4b33-bcc1-482dc59ebb32",
      "subscription_id": "aa11a4c2-a467-43db-b413-c4ab0f5cf627",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "paid_at": "2019-08-24T14:15:22Z",
      "canceled_at": "2019-08-24T14:15:22Z",
      "fulfilled_at": "2019-08-24T14:15:22Z",
      "expires_at": "2019-08-24T14:15:22Z"
    }
  ],
  "has_more": true,
  "total_count": 0
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string",
    "param": "string"
  }
}
Edit on GitHub