---
title: "List orders"
method: GET
path: "/organizations/{organization_id}/orders"
tags: ["Orders"]
---

# List orders

`GET /organizations/{organization_id}/orders`

Retrieves orders for the specified organization.

## Path parameters

- `organization_id` string, required

## Query parameters

- `filter[status]` 'completed' | 'past_due' | 'pending' | 'canceled' | 'payment_failed_soft_decline' | 'payment_failed_hard_decline'
- `filter[total]` integer
- `page` integer
- `mode` 'details'

## Response `200`

OK

- object
  - `items` Order[]
    - `id` string — The ID of the order.
    - `status` 'completed' | 'past_due' | 'pending' | 'canceled' | 'payment_failed_soft_decline' | 'payment_failed_hard_decline' — The status of the subscription.
    - `owner` string, uuid — The UUID of the owner.
    - `address` Address — The address of the user.
      - `country` string, ISO ALPHA-2 — Two-letter country codes are used to represent countries and states
      - `name_line` string — The full name of the user
      - `premise` string — Premise (i.e. Apt, Suite, Bldg.)
      - `sub_premise` string — Sub Premise (i.e. Suite, Apartment, Floor, Unknown.
      - `thoroughfare` string — The address of the user
      - `administrative_area` string, ISO ALPHA-2 — The administrative area of the user address
      - `sub_administrative_area` string — The sub-administrative area of the user address
      - `locality` string — The locality of the user address
      - `dependent_locality` string — The dependant_locality area of the user address
      - `postal_code` string — The postal code area of the user address
    - `company` string — The company name.
    - `vat_number` string — An identifier used in many countries for value added tax purposes.
    - `billing_period_start` string, date-time — The time when the billing period of the order started.
    - `billing_period_end` string, date-time — The time when the billing period of the order ended.
    - `billing_period_label` object — Descriptive information about the billing cycle.
      - `formatted` string — The renderable label for the billing cycle.
      - `month` string — The month of the billing cycle.
      - `year` string — The year of the billing cycle.
      - `next_month` string — The name of the next month following this billing cycle.
    - `billing_period_duration` integer — The duration of the billing period of the order in seconds.
    - `paid_on` string, date-time, nullable — The time when the order was successfully charged.
    - `total` integer — The total of the order.
    - `total_formatted` integer — The total of the order, formatted with currency.
    - `components` Components — The components of the project
      - `voucher/vat/baseprice` object — stub
    - `currency` string — The order currency code.
    - `invoice_url` string — A link to the PDF invoice.
    - `last_refreshed` string, date-time — The time when the order was last refreshed.
    - `invoiced` boolean — The customer is invoiced.
    - `line_items` LineItem[] — The line items that comprise the order.
      - `type` 'project_plan' | 'project_feature' | 'project_subtotal' | 'organization_plan' | 'organization_feature' | 'organization_subtotal' — The type of line item.
      - `license_id` number, nullable — The associated subscription identifier.
      - `project_id` string, nullable — The associated project identifier.
      - `product` string — Display name of the line item product.
      - `sku` string — The line item product SKU.
      - `total` number — Total price as a decimal.
      - `total_formatted` string — Total price, formatted with currency.
      - `components` object — The price components for the line item, keyed by type.
      - `exclude_from_invoice` boolean — Line item should not be considered billable.
    - `_links` object — Links to related API endpoints.
      - `invoices` object — Link to related Invoices API. Use this to retrieve invoices related to this order.
        - `href` string — URL of the link
  - `_links` ListLinks
    - `self` Link — A hypermedia link to the {current, next, previous} set of items.
      - `href` string — URL of the link
    - `previous` Link — A hypermedia link to the {current, next, previous} set of items.
      - `href` string — URL of the link
    - `next` Link — A hypermedia link to the {current, next, previous} set of items.
      - `href` string — URL of the link

## Other responses

- `403` — Forbidden
- `404` — Not Found

---

[API](https://skmtc.net/upsun/apis/upsun-com-rest-api.md) · [All operations](https://skmtc.net/upsun/apis/upsun-com-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/upsun/upsun-com-rest-api/revisions/6cc88fde6435/schema)