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

# List subscriptions

`GET /organizations/{organization_id}/subscriptions`

Retrieves subscriptions for the specified organization.

## Path parameters

- `organization_id` string, ulid, required

## Query parameters

- `filter[status]` 'active' | 'provisioning' | 'provisioning failure' | 'suspended' | 'deleted'
- `filter[id]` string
- `filter[project_id]` StringFilter
  - `eq` string — Equal
  - `ne` string — Not equal
  - `in` string — In (comma-separated list)
  - `nin` string — Not in (comma-separated list)
  - `between` string — Between (comma-separated list)
  - `contains` string — Contains
  - `starts` string — Starts with
  - `ends` string — Ends with
- `filter[project_title]` StringFilter
  - `eq` string — Equal
  - `ne` string — Not equal
  - `in` string — In (comma-separated list)
  - `nin` string — Not in (comma-separated list)
  - `between` string — Between (comma-separated list)
  - `contains` string — Contains
  - `starts` string — Starts with
  - `ends` string — Ends with
- `filter[region]` StringFilter
  - `eq` string — Equal
  - `ne` string — Not equal
  - `in` string — In (comma-separated list)
  - `nin` string — Not in (comma-separated list)
  - `between` string — Between (comma-separated list)
  - `contains` string — Contains
  - `starts` string — Starts with
  - `ends` string — Ends with
- `filter[updated_at]` DateTimeFilter
  - `eq` string — Equal
  - `ne` string — Not equal
  - `between` string — Between (comma-separated list)
  - `gt` string — Greater than
  - `gte` string — Greater than or equal
  - `lt` string — Less than
  - `lte` string — Less than or equal
- `page[size]` integer
- `page[before]` string
- `page[after]` string
- `sort` string

## Response `200`

OK

- object
  - `items` Subscription[]
    - `id` string — The internal ID of the subscription.
    - `status` 'requested' | 'provisioning failure' | 'provisioning' | 'active' | 'suspended' | 'deleted' — The status of the subscription.
    - `created_at` string, date-time — The date and time when the subscription was created.
    - `updated_at` string, date-time — The date and time when the subscription was last updated.
    - `owner` string, uuid — The UUID of the owner.
    - `owner_info` OwnerInfo — Project owner information that can be exposed to collaborators.
      - `type` string — Type of the owner, usually 'user'.
      - `username` string — The username of the owner.
      - `display_name` string — The full name of the owner.
    - `vendor` string — The machine name of the vendor the subscription belongs to.
    - `plan` string — The plan type of the subscription.
    - `environments` integer — The number of environments which can be provisioned on the project.
    - `storage` integer — The total storage available to each environment, in MiB. Only multiples of 1024 are accepted as legal values.
    - `user_licenses` integer — The number of chargeable users who currently have access to the project. Manage this value by adding and removing users through the Platform project API. Staff and billing/administrative contacts can be added to a project for no charge. Contact support for questions about user licenses.
    - `project_id` string — The unique ID string of the project.
    - `project_endpoint` string — The project API endpoint for the project.
    - `project_title` string — The name given to the project. Appears as the title in the UI.
    - `project_region` string — The machine name of the region where the project is located. Cannot be changed after project creation.
    - `project_region_label` string — The human-readable name of the region where the project is located.
    - `project_ui` string — The URL for the project's user interface.
    - `project_options` ProjectOptions — The project options object.
      - `defaults` object — The initial values applied to the project.
        - `settings` object — The project settings.
        - `variables` object — The project variables.
        - `access` object — The project access list.
        - `capabilities` object — The project capabilities.
      - `enforced` object — The enforced values applied to the project.
        - `settings` object — The project settings.
        - `capabilities` object — The project capabilities.
      - `regions` string[] — The available regions.
      - `plans` string[] — The available plans.
      - `billing` object — The billing settings.
    - `agency_site` boolean — True if the project is an agency site.
    - `invoiced` boolean — Whether the subscription is invoiced.
    - `hipaa` boolean — Whether the project is marked as HIPAA.
    - `is_trial_plan` boolean — Whether the project is currently on a trial plan.
    - `services` object[] — Details of the attached services.
    - `green` boolean — Whether the subscription is considered green (on a green region, belonging to a green vendor) for billing purposes.
  - `_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)