Répertorier les abonnements d’une organisation.¶

Méthode¶

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

Description¶

Renvoie les détails des abonnements de l’organisation indiquée. Chaque locataire de l’organisation dispose de son propre abonnement. Utilisez les paramètres de requête limit et page_token pour parcourir les résultats page par page.

Paramètres de chemin¶

org_id string obligatoire

Identifiant de l’organisation.

Paramètres de requête¶

limit int32

Nombre maximal d’éléments à renvoyer par page.

page_token string

Jeton renvoyé par l’appel précédent (next_page_token), à utiliser pour obtenir la suite des résultats.

curl

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

Schéma de la réponse en cas de succès (200)¶

object

SubscriptionsPage contient les abonnements renvoyés sur cette page.

next_page_token string

Jeton permettant d’obtenir la page suivante. Transmettez cette valeur dans le paramètre page_token de la requête suivante. Le jeton est vide sur la dernière page.

items array of objects

Liste des abonnements qui correspondent à la requête.

object

Subscription décrit l’état et les détails d’un abonnement au service.

id string

Identifiant de l’abonnement.

status string

État de l’abonnement. Les valeurs possibles sont notamment trial, trial_expired, active, expired et canceled.

expires date-time

Date et heure prévues d’expiration de l’abonnement ou, s’il est actif, de son renouvellement.

tenant_id string

Identifiant du locataire auquel l’abonnement est attribué.

items array of objects

Éléments d’abonnement correspondant aux catégories d’éléments facturables couvertes par cet abonnement.

object

SubscriptionItem décrit les détails de l’abonnement pour un type d’élément facturable donné (ressource (utilisateur), stockage, machine virtuelle, nœud, etc.).

kind string

Type d’élément d’abonnement (par exemple, ressource, stockage, nœud, machine virtuelle ou base de données).

qty int64

Nombre d’unités sous licence pour ce type d’élément facturable (par exemple, 10 ressources ou 5 licences de stockage supplémentaires donnant chacune droit à un quota de 100 Go).

auto_license boolean

Indique si le service ajuste automatiquement le nombre d’unités de cet élément d’abonnement en fonction de la consommation actuelle. Ce paramètre est configuré par un administrateur.

auto_license_max int64

Nombre maximal d’unités que l’ajustement automatique des licences peut attribuer. Cette limite est configurée par un administrateur.

quotas array of objects

Limites de quota accordées au locataire par cet abonnement.

object

Quota décrit les limites définies par la licence pour un type d’élément donné.

kind string

Type d’élément couvert par ce quota (ressource (utilisateur), stockage, machine virtuelle, nœud, etc.).

count int64

Nombre maximal d’unités autorisé pour cet élément.

units string

Unité de mesure du quota. Ce champ est vide pour les quotas de ressources ou de nœuds et contient MB ou GB pour le stockage.

Exemple de réponse¶

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