> ## Documentation Index
> Fetch the complete documentation index at: https://docs.acedata.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# Get the AceDataCloud Platform Order List

> Platform integration guide - Ace Data Cloud

Returns the account's top-up orders in pages, suitable for finding order IDs, checking payment status, and reconciliation.

## Preparation

Create an [Account Token](https://platform.acedata.cloud/documents/platform-token), and obtain the current account UUID from `GET /api/v1/platform-tokens/me/`.

```shell theme={null}
export PLATFORM_TOKEN='your account token'
export USER_ID='your account UUID'
```

## API Overview

| Item | Content |
| - | - |
| Method | `GET` |
| URL | `https://platform.acedata.cloud/api/v1/orders/` |
| Authentication | Account Token, OAuth token requires `orders:read` |
| Pagination | `count` + `items` |

Regular users must provide their own `user_id`; otherwise, the pagination may return `403` when encountering unauthorized objects.

## Query Parameters

| Parameter | Type | Required | Description |
| - | - | - | - |
| `user_id` | UUID | Required for regular users | The account to which the order belongs; supports repeated parameters |
| `pay_way` | string | No | Filter by payment method; supports repeated or comma-separated values |
| `state` | string | No | Filter by status; supports repeated or comma-separated values |
| `created_at_from/to` | datetime | No | Creation time range |
| `finished_at_from/to` | datetime | No | Completion time range |
| `limit` / `offset` | integer | No | Pagination |
| `ordering` | string | No | `created_at`, `-created_at`, `finished_at`, or `-finished_at` |

The current list does not support filtering by `application_id`, `service_id`, `package_id`, `payment_method`, or `tag`; the payment method field name is `pay_way`.

```shell theme={null}
curl --get 'https://platform.acedata.cloud/api/v1/orders/' \
  --data-urlencode "user_id=${USER_ID}" \
  --data-urlencode 'state=Paid,Finished' \
  --data-urlencode 'pay_way=Stripe' \
  --data-urlencode 'limit=100' \
  -H "Authorization: Bearer ${PLATFORM_TOKEN}"
```

## Response Description

The response is `{count, items}`. Production list items contain `id`, `user_id`, `application_id/application_ids`, `package_id/package_ids`, `price`, `amount`, `discount`, `remaining_amount`, `state`, `pay_way`, `pay_id`, `pay_url`, `finished_at`, `expired_at`, `invoice`, `metadata`, and time fields.

* The actual statuses are `Pending`, `Paid`, `Finished`, `Expired`, `Failed`, and `Refunded`; there is no `Cancelled`.
* The field names are `pay_way`, `finished_at`, `discount`, and `price`, not `payment_method`, `paid_at`, `discount_rate`, or `final_price`.
* `price` is the final price recorded for the order; currency and settlement details may be located in controlled metadata and cannot be inferred solely from the payment method.

## Related APIs

* [Create a Top-up Order](https://platform.acedata.cloud/documents/platform-order-create)
* [Get Order Details](https://platform.acedata.cloud/documents/platform-order-detail)
* [Pay for an Order](https://platform.acedata.cloud/documents/platform-order-pay)
* [Refresh Order Status](https://platform.acedata.cloud/documents/platform-order-refresh)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.