Skip to main content
GET
/
organizations
/
{organization_id}
/
orders
Error
A valid request URL is required to generate request examples
{
  "items": [
    {
      "id": "<string>",
      "status": "completed",
      "owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "address": {
        "country": "<string>",
        "name_line": "<string>",
        "premise": "<string>",
        "sub_premise": "<string>",
        "thoroughfare": "<string>",
        "administrative_area": "<string>",
        "sub_administrative_area": "<string>",
        "locality": "<string>",
        "dependent_locality": "<string>",
        "postal_code": "<string>"
      },
      "company": "<string>",
      "vat_number": "<string>",
      "billing_period_start": "2023-11-07T05:31:56Z",
      "billing_period_end": "2023-11-07T05:31:56Z",
      "billing_period_label": {
        "formatted": "<string>",
        "month": "<string>",
        "year": "<string>",
        "next_month": "<string>"
      },
      "billing_period_duration": 123,
      "paid_on": "2023-11-07T05:31:56Z",
      "total": 123,
      "total_formatted": 123,
      "components": {
        "voucher/vat/baseprice": {}
      },
      "currency": "<string>",
      "invoice_url": "<string>",
      "last_refreshed": "2023-11-07T05:31:56Z",
      "invoiced": true,
      "line_items": [
        {
          "type": "project_plan",
          "license_id": 123,
          "project_id": "<string>",
          "product": "<string>",
          "sku": "<string>",
          "total": 123,
          "total_formatted": "<string>",
          "components": {},
          "exclude_from_invoice": true
        }
      ],
      "_links": {
        "invoices": {
          "href": "<string>"
        }
      }
    }
  ],
  "_links": {
    "self": {
      "href": "<string>"
    },
    "previous": {
      "href": "<string>"
    },
    "next": {
      "href": "<string>"
    }
  }
}

Authorizations

Authorization
string
header
required

Path Parameters

organization_id
string
required

The ID of the organization.
Prefix with name= to retrieve the organization by name instead.

Query Parameters

filter[status]
enum<string>

The status of the order.

Available options:
completed,
past_due,
pending,
canceled,
payment_failed_soft_decline,
payment_failed_hard_decline
filter[total]
integer

The total of the order.

page
integer<int32>

Page to be displayed. Defaults to 1.

mode
enum<string>

The output mode.

Available options:
details

Response

OK

items
object[]