---
title: "List your orders"
method: GET
path: "/v1/orders"
tags: ["Orders"]
---

# List your orders

`GET /v1/orders`

Tenant-scoped list, newest first, keyset-paginated. Pass the returned
`next_cursor` back as `?cursor=` to page; a null `next_cursor` is the
last page.

## Query parameters

- `status` 'received' | 'awaiting_payment' | 'paid' | 'reserved' | 'swapping' | 'funding' | 'purchasing' | 'fulfilling' | 'completed' | 'delivered' | 'failed' | 'reversed' | 'expired' | 'held' | 'cancelled' — Lifecycle status. `awaiting_payment` is the only cancellable state.
- `limit` integer
- `cursor` string

## Response `200`

A page of orders.

- object
  - `orders` Order[], required
    - `order_id` string, uuid, required
    - `status` 'received' | 'awaiting_payment' | 'paid' | 'reserved' | 'swapping' | 'funding' | 'purchasing' | 'fulfilling' | 'completed' | 'delivered' | 'failed' | 'reversed' | 'expired' | 'held' | 'cancelled', required — Lifecycle status. `awaiting_payment` is the only cancellable state.
    - `type` 'stars' | 'premium', required
    - `recipient_username` string, required
    - `quantity` integer, nullable
    - `months` integer, nullable
    - `amount_ton` string, nullable — The GRAM fulfilment cost (decimal string), when known. The field name `amount_ton` is frozen for wire compatibility.
    - `payment_tx` string, nullable
    - `purchase_tx` string, nullable
    - `failure_reason` string, nullable — Why the order ended where it did, when not `delivered`: `underpaid` / `overpaid` / `no_memo` / `wrong_memo` (→ `failed`, funds reversed), `undeliverable` (→ `reversed`, funds reversed), or `expired`. Null otherwise. See **Reversals & delivery**.
    - `reversal_tx` string, nullable
    - `telegram_message` string, nullable — A verbatim user-facing message from Fragment, when present.
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `expires_at` string, date-time, nullable — Non-null only while `awaiting_payment`.
  - `next_cursor` string, nullable, required — Pass back as `?cursor=`; null on the last page.

## Other responses

- `400` — Malformed request.
- `401` — Missing or invalid `X-Api-Key`.
- `429` — A rate limit was reached — the per-minute request budget, the tighter pricing/recipient-check probe cap (60 req/min), the daily order cap, or the per-recipient flood guard. See **Rate limits** in the overview. The per-minute-budget responses also carry `RateLimit-*` + `Retry-After` headers.

---

[API](https://skmtc.net/mystars/apis/mystars-faas-fulfilment-api.md) · [All operations](https://skmtc.net/mystars/apis/mystars-faas-fulfilment-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mystars/mystars-faas-fulfilment-api/revisions/3c24cb3dfa12/schema)