Skip to content

List organization subscriptions.

Method

GET https://papi.afi.ai/api/v1/orgs/{org_id}/licensing/subscriptions

Description

Returns subscription details for the specified organization. Each tenant in the organization has its own subscription. Use the limit and page_token query parameters to paginate the results.

Path params
org_id string required

ID of the organization whose subscriptions to list.
Query params
limit int32

Maximum number of items to return per page.
page_token string

Token from the previous list operation (`next_page_token`) used to continue listing.

 
curl -X GET \
    -H 'Authorization: {api-key}' \
    https://papi.afi.ai/api/v1/orgs/{org_id}/licensing/subscriptions
Successful response (200) schema
object

SubscriptionsPage contains the results of listing subscriptions.
next_page_token string

Token for the next page in the listing operation. Set this value as `page_token` in the subsequent request. Empty on the last page.
items array of objects

List of subscriptions that match the request.

object

Subscription describes the status and details of a service subscription.
id string

ID of the subscription.
status string

Subscription status. Possible values include `trial`, `trial_expired`, `active`, `expired`, and `canceled`.
expires date-time

Expected time when the subscription expires or renews (for active subscriptions).
tenant_id string

ID of the tenant the subscription is assigned to.
items array of objects

Subscription items for billable item classes licensed by this subscription.

object

SubscriptionItem describes subscription details for a specific billable item kind (resource (user), storage, virtual machine, node, etc.).
kind string

Subscription item kind (for example, resource, storage, node, virtual machine, or database).
qty int64

Number of licensed units for the billable item kind (for example, 10 resources or 5 additional storage licenses, each granting 100 GB of quota).
auto_license boolean

Indicates whether the service automatically adjusts this subscription item based on current consumption. An administrator configures this setting.
auto_license_max int64

Maximum quantity that the automatic license adjustment procedure can set. An administrator configures this limit.
quotas array of objects

Quota limits this subscription grants to the tenant.

object

Quota describes the licensed limits for a specific item kind.
kind string

Kind of item covered by this quota (resource (user), storage, virtual machine, node, etc.).
count int64

Maximum number of units allowed for this item.
units string

Unit of measure used for this quota (empty for resource/node quotas; MB or GB for storage).
Response example
{
  "next_page_token": "string",
  "items": [
    {
      "id": "string",
      "status": "string",
      "expires": "2025-11-19T20:02:49.302263Z",
      "tenant_id": "string",
      "items": [
        {
          "kind": "string",
          "qty": "int64-as-string",
          "auto_license": true,
          "auto_license_max": "int64-as-string"
        }
      ],
      "quotas": [
        {
          "kind": "string",
          "count": "int64-as-string",
          "units": "string"
        }
      ]
    }
  ]
}