Listar las suscripciones de una organización.¶

Método¶

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

Descripción¶

Devuelve los detalles de las suscripciones de la organización indicada. Cada inquilino de la organización tiene su propia suscripción. Utilice los parámetros de consulta limit y page_token para recorrer los resultados página por página.

Parámetros de ruta¶

org_id string obligatorio

ID de la organización cuyas suscripciones se van a listar.

Parámetros de consulta¶

limit int32

Número máximo de elementos por página.

page_token string

Token de la operación de listado anterior (next_page_token) que permite continuar el listado.

curl

curl -X GET \
    -H 'Authorization: {api-key}' \
    https://papi.afi.ai/api/v1/orgs/{org_id}/licensing/subscriptions

Esquema de respuesta correcta (200)¶

object

SubscriptionsPage contiene los resultados del listado de suscripciones.

next_page_token string

Token para obtener la página siguiente del listado. Envíelo como page_token en la siguiente solicitud. Está vacío en la última página.

items array of objects

Lista de suscripciones que coinciden con la solicitud.

object

Subscription describe el estado y los detalles de una suscripción al servicio.

id string

ID de la suscripción.

status string

Estado de la suscripción. Los valores posibles incluyen trial, trial_expired, active, expired y canceled.

expires date-time

Fecha y hora previstas de caducidad de la suscripción o, si está activa, de su renovación.

tenant_id string

ID del inquilino al que está asignada la suscripción.

items array of objects

Elementos de suscripción correspondientes a las clases de elementos facturables cubiertas por la suscripción.

object

SubscriptionItem describe los detalles de la suscripción para un tipo concreto de elemento facturable: recurso (usuario), almacenamiento, máquina virtual, nodo, etc.

kind string

Tipo de elemento de suscripción (por ejemplo, recurso, almacenamiento, nodo, máquina virtual o base de datos).

qty int64

Número de unidades con licencia de este tipo de elemento facturable (por ejemplo, 10 recursos o 5 licencias adicionales de almacenamiento, cada una con una cuota de 100 GB).

auto_license boolean

Indica si el servicio ajusta automáticamente la cantidad de unidades de este elemento de suscripción según el consumo actual. Esta opción la configura un administrador.

auto_license_max int64

Cantidad máxima que puede establecer el ajuste automático del número de licencias. Este límite lo configura un administrador.

quotas array of objects

Límites de cuota que la suscripción concede al inquilino.

object

Quota describe los límites establecidos por la licencia para un tipo de elemento concreto.

kind string

Tipo de elemento al que se aplica esta cuota: recurso (usuario), almacenamiento, máquina virtual, nodo, etc.

count int64

Número máximo de unidades permitidas para este elemento.

units string

Unidad de medida de la cuota. El campo está vacío para las cuotas de recursos o nodos; para el almacenamiento, contiene MB o GB.

Ejemplo de respuesta¶

{
  "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"
        }
      ]
    }
  ]
}