GET /v1/orders

Scope

read_orders

Request parameters

Name	In	Type	Required	Description
limit	query	integer	optional	How many entries to return (1-100). Defaults to 20.
offset	query	integer	optional	Zero-based offset to start from. ⚠️ Entries updated mid-scan can be missed. For incremental order fetching, use after_id with updated_since instead.
status	query	object	optional	Filter by order status.
after_id	query	string	optional	A cursor for continuing from where you left off. Combined with updated_since, it returns entries after this ID within the same update time. Use it instead of offset so that orders updated mid-scan are not missed.
updated_since	query	string	optional	ISO 8601. Returns only orders updated at or after this time (inclusive). Use it for incremental fetching: results come back oldest-updated first (ties broken by order ID), so the last update time you received becomes the cursor for the next call.

Response example

{
  "data": [
    {
      "id": "1001",
      "ordered_at": "2026-06-01T03:00:00Z",
      "updated_at": "2026-06-01T03:30:00Z",
      "status": "init",
      "payment_method": "card",
      "total": {
        "amount": 3200,
        "currency": "JPY"
      },
      "is_subscription": true,
      "inflow_route": {
        "id": "12",
        "code": "gift-quick",
        "name": "ギフトクイックURL"
      },
      "gift_status": "none",
      "gift_source_order_id": "1000"
    }
  ],
  "pagination": {
    "limit": 0,
    "offset": 0,
    "total": 0
  }
}

Description

List orders (header only; buyer PII excluded)

Error response example

{
  "error": {
    "code": "insufficient_scope",
    "message": "requires scope 'read_orders'",
    "request_id": "req_01H..."
  }
}

Possible errors: 400 / 401 / 403