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 possè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 dont les abonnements doivent être répertoriés.

Paramètres de requête¶

limit int32

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

page_token string

Jeton de l’opération de liste précédente (`next_page_token`) utilisé pour poursuivre l’énumération.

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 réussie (200)¶

object

SubscriptionsPage contient les résultats de l’énumération des abonnements.

next_page_token string

Jeton de la page suivante dans l’opération d’énumération. Définissez cette valeur comme `page_token` dans la requête suivante. 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 comprennent `trial`, `trial_expired`, `active`, `expired` et `canceled`.

expires date-time

Date et heure prévues d’expiration ou de renouvellement de l’abonnement (pour les abonnements actifs).

tenant_id string

Identifiant du locataire auquel l’abonnement est attribué.

items array of objects

Éléments d’abonnement pour les catégories d’éléments facturables couvertes par cet abonnement.

object

SubscriptionItem décrit les détails de l’abonnement pour un type précis d’élément facturable (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 le type d’élément facturable (par exemple, 10 ressources ou 5 licences de stockage supplémentaires accordant chacune un quota de 100 Go).

auto_license boolean

Indique si le service ajuste automatiquement cet élément d’abonnement en fonction de la consommation actuelle. Un administrateur configure ce paramètre.

auto_license_max int64

Quantité maximale que la procédure d’ajustement automatique des licences peut définir. Un administrateur configure cette limite.

quotas array of objects

Limites de quota que cet abonnement accorde au locataire.

object

Quota décrit les limites sous 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 utilisée pour ce quota (vide pour les quotas de ressources ou de nœuds ; Mo ou Go 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"
        }
      ]
    }
  ]
}