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

# List order statuses

> Returns the order status values, API keys, labels, and descriptions used by the order endpoints.



## OpenAPI

````yaml /api-reference/openapi.json get /order/statuses
openapi: 3.1.0
info:
  title: BillingServ API V2
  description: >-
    Resources and tools for developers to integrate with the BillingServ v2 API,
    including customer management, domain availability, hosted checkout,
    billing, and service operations. Authenticated API responses include
    X-Request-ID and X-API-Version: 2 headers, and rate-limited endpoints expose
    standard rate-limit headers and return 429 when a limit is exceeded. Clients
    may provide X-Request-ID for request correlation. The supported idempotent
    write operations accept Idempotency-Key. Internal service-to-service routes
    are intentionally excluded from this public contract. v1 is deprecated; use
    the v2 base URL and bearer-token authentication unless an endpoint states
    otherwise.
  version: '2.0'
servers:
  - url: https://demo.onlinebillingform.com/api/v2
    description: BillingServ demo API
security:
  - bearerAuth: []
tags:
  - name: Customer
  - name: Package
  - name: Group
  - name: Country
  - name: County
  - name: Currency
  - name: VPN
  - name: Invoice
  - name: Order
  - name: Module
  - name: Report
  - name: Marketing
  - name: Setting
  - name: Checkout
  - name: Domain
    description: Search enabled domain extensions and check domain availability.
  - name: Usage
  - name: Support
  - name: Licensing
  - name: Webhooks
    description: Outbound events sent by BillingServ to a configured customer endpoint.
paths:
  /order/statuses:
    get:
      tags:
        - Order
      summary: List order statuses
      description: >-
        Returns the order status values, API keys, labels, and descriptions used
        by the order endpoints.
      operationId: GET_order_statuses
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderStatusesResponse'
              example:
                success: true
                statuses:
                  - status: '0'
                    status_key: RECENT
                    status_label: Recent
                    description: The order has been received and is awaiting processing.
                  - status: '1'
                    status_key: PENDING
                    status_label: Pending
                    description: >-
                      The order is waiting for a required action or external
                      processing.
                  - status: '2'
                    status_key: SETUP
                    status_label: Setup
                    description: >-
                      The order has been accepted and is being configured or
                      provisioned.
                  - status: '3'
                    status_key: SHIPPED
                    status_label: Shipped
                    description: The order has been fulfilled or dispatched.
                  - status: '4'
                    status_key: CANCELLED
                    status_label: Cancelled
                    description: The order has been canceled before completion.
                  - status: '5'
                    status_key: RETURNED
                    status_label: Returned
                    description: The fulfilled order has been returned.
                  - status: '6'
                    status_key: TERMINATED
                    status_label: Terminated
                    description: The order has been permanently ended.
                  - status: '7'
                    status_key: SUSPENDED
                    status_label: Suspended
                    description: The order is temporarily paused or disabled.
                  - status: '8'
                    status_key: ERROR
                    status_label: Error
                    description: The order could not be processed successfully.
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                success: false
                errors: Invalid API Key
        '403':
          description: Authenticated key does not have permission for this endpoint
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                success: false
                errors: Insufficient permissions for this endpoint.
      security:
        - bearerAuth: []
components:
  schemas:
    OrderStatusesResponse:
      type: object
      properties:
        success:
          type: boolean
          const: true
        statuses:
          type: array
          items:
            $ref: '#/components/schemas/StatusDefinition'
      required:
        - success
        - statuses
      additionalProperties: true
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          const: false
        errors:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              additionalProperties: true
        code:
          type: string
          description: Machine-readable error category when provided.
        request_id:
          type: string
          description: Request identifier returned in the X-Request-ID response header.
      additionalProperties: true
    StatusDefinition:
      type: object
      properties:
        status:
          type: string
          description: >-
            Numeric status value returned on the corresponding invoice or order
            resource.
        status_key:
          type: string
          description: Stable API key accepted by status-filter endpoints.
        status_label:
          type: string
          description: Human-readable status label.
        description:
          type: string
          description: Meaning of the status.
      required:
        - status
        - status_key
        - status_label
        - description
      additionalProperties: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: 'Use `Authorization: Bearer <live_api_key>`.'

````