---
title: "List orders by status"
method: GET
path: "/order/get-orders-by-status"
tags: ["Order"]
---

# List orders by status

`GET /order/get-orders-by-status`

## Request

- Base URL: `https://demo.onlinebillingform.com/api/v2`
- URL: `https://demo.onlinebillingform.com/api/v2/order/get-orders-by-status`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/billingserv/apis/billingserv-api-v2/docs/order/get-orders-by-status/get.ts> (a function with typed inputs; its response is checked against the schema)

Use this BillingServ API endpoint to list orders by status. Review the response for the operation result or validation errors.

## Query parameters

- `status` 'RECENT' | 'PENDING' | 'SETUP' | 'SHIPPED' | 'CANCELLED' | 'RETURNED' | 'TERMINATED' | 'SUSPENDED' | 'ERROR' | 'ALL', required: Status key from GET /api/v2/order/statuses, or ALL.
- `per_page` integer

## Response `200`

OK

- ApiResponse
  - `success` boolean

## Other responses

- `401`: Missing or invalid API key
- `403`: Authenticated key does not have permission for this endpoint
- `422`: Validation error

## Changes

- **2026-08-22** `76cfbed5eb40`: 1 breaking, 11 info
  - the `query` request parameter `status` was restricted to a list of enum values
  - added the new enum value `ALL` to the `query` request parameter `status`
  - added the new enum value `CANCELLED` to the `query` request parameter `status`
  - added the new enum value `ERROR` to the `query` request parameter `status`
  - …8 more
- **2026-08-22** `6b9208b64456`: 6 info
  - added the optional property `code` to the response with the `401` status
  - added the optional property `code` to the response with the `403` status
  - added the optional property `code` to the response with the `422` status
  - added the optional property `request_id` to the response with the `401` status
  - …2 more

[Operation history](https://skmtc.dev/billingserv/apis/billingserv-api-v2/changes/order/get-orders-by-status/get.md)

---

[API](https://skmtc.dev/billingserv/apis/billingserv-api-v2.md) - [All operations](https://skmtc.dev/billingserv/apis/billingserv-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/billingserv/apis/billingserv-api-v2/revisions/232ab5ca8413?raw)