Skip to main content
Astra Automation
Une version plus récente de ce produit est disponible.
La version française est une traduction automatique. La version anglaise prévaut sur la française en cas de divergence.

Modifier un abonnement

PDF

PUT /accounts/{account_id}/core/v1/subscriptions/{subscription_id}

Remplace l'intégralité de la ressource stockée par le corps de la requête JSON fourni, tout en préservant les valeurs clés non modifiables par l'utilisateur.

Effets secondaires

  • Si l'utilisateur annule l'abonnement, le point de terminaison PUT doit être appelé avec "status": "inactive".

  • Lorsque le statut est défini sur « inactif », les frais en attente pour cet abonnement sont envoyés à Zuora et l'abonnement Zuora sera marqué comme « inactif » d'une manière ou d'une autre.

Paramètres

Nom Type Dans Obligatoire Description

identifiant_compte

chaîne

chemin

Vrai

ID de la ressource de compte conteneur

  • exemple: {{.Account}}

id_abonnement

chaîne

chemin

Vrai

ID de la collection d'abonnements à lister

Corps de la requête

Remplace l'intégralité de la ressource stockée par le corps de la requête JSON fourni, tout en préservant les valeurs clés non modifiables par l'utilisateur.

Effets secondaires

  • Si l'utilisateur annule l'abonnement, le point de terminaison PUT doit être appelé avec "status": "inactive".

  • Lorsque le statut est défini sur « inactif », les frais en attente pour cet abonnement sont envoyés à Zuora et l'abonnement Zuora sera marqué comme « inactif » d'une manière ou d'une autre.

Nom Type Obligatoire Description

type

chaîne

Vrai

Type de média de la ressource. Les valeurs définies sont :

  • "application/astra-subscription"

version

chaîne

Vrai

Version de la ressource. Les valeurs définies sont :

  • "1,0"

  • "1,1"

  • "1,2"

id

chaîne

Faux

Identifiant unique global de la ressource. Les valeurs définies sont :

  • Conforme au schéma UUIDv4

ID de profil client

chaîne

Faux

La chaîne JSON contenant l’identifiant du profil client à partir de "Authorize.net", qui a été invoqué par l’interface utilisateur, n’est pas définie pour le délai de grâce. Renvoie une chaîne vide lors de l’opération de lecture, si elle n’est pas définie. Les valeurs définies sont :

  • Longueur minimale : 0

  • Longueur maximale : 63

paymentFirstName

chaîne

Faux

Chaîne JSON contenant un prénom complet spécifié par l'utilisateur, utilisé pour la facturation. Spécifié uniquement lorsque l'abonnement est refacturé. Les valeurs définies sont :

  • Longueur minimale : 1

  • Longueur maximale : 63

paymentLastName

chaîne

Faux

Chaîne JSON contenant un nom de famille complet spécifié par l'utilisateur, utilisé pour la facturation. Spécifié uniquement lorsque l'abonnement est refacturé. Les valeurs définies sont :

  • Longueur minimale : 1

  • Longueur maximale : 63

paymentAddress

"paymentAddress"

Faux

Objet JSON contenant une collection de chaînes JSON spécifiant une adresse de facturation. Spécifié uniquement lorsque l'abonnement est refacturé. Si cette clé existe, les six chaînes JSON qu'elle contient seront présentes. Si rien n'a été fourni par l'utilisateur, la chaîne sera vide.

ID de profil de paiement

chaîne

Faux

Chaîne JSON contenant l'identifiant du profil de paiement de "Authorize.net" qui a été invoqué par l'interface utilisateur, non défini pour la période d'essai. Renvoie une chaîne vide lors de l'opération de lecture si non défini. Les valeurs définies sont :

  • Longueur minimale : 0

  • Longueur maximale : 63

paymentExpiry

chaîne

Faux

Chaîne JSON contenant un horodatage indiquant la date d'expiration du mode de paiement. Cette information est obtenue auprès d'authorize.net(http://authorize.net et définie par l'interface utilisateur. Les valeurs définies sont :

  • Conforme au schéma de date et d'heure ISO-8601 Ce champ n'est pas renvoyé pour les périodes d'essai.

purchaseOrderNumber

chaîne

Faux

Chaîne JSON contenant le numéro de bon de commande pour le mode de paiement. Les valeurs définies sont :

  • Longueur minimale : 1

  • Longueur maximale : 31

marketplace

chaîne

Faux

Chaîne JSON indiquant la marketplace du compte sur laquelle les paiements seront enregistrés. Valeurs définies :

  • "netapp"

  • "azure"

  • "aws"

  • "gcp"

licenseSN

chaîne

Faux

Chaîne JSON contenant le numéro de série de la licence pour le mode de paiement. Les valeurs définies sont :

  • Longueur minimale : 1

  • Longueur maximale : 31

termes

chaîne

Faux

Chaîne JSON indiquant le niveau actuel du compte. Les valeurs définies sont :

  • "essai"

  • "payé"

statut

chaîne

Faux

Chaîne JSON indiquant l'état actuel de l'abonnement. Les valeurs définies sont :

  • "actif"

  • "inactif"

appLimit

nombre

Faux

Numéro JSON indiquant la limite d'application pour cet abonnement. La valeur -1 indique une absence de limite.

namespaceLimit

nombre

Faux

Numéro JSON indiquant la limite d'espace de noms pour cet abonnement. La valeur -1 indique une absence de limite.

subscriptionPeriod

nombre

Faux

Nombre JSON indiquant la période d'abonnement. La valeur -1 indique une absence de limite. Unité : jours

gracePeriod

nombre

Faux

Numéro JSON indiquant le délai de grâce après l'expiration de l'abonnement d'essai ou l'annulation d'un abonnement payant. Unité : jours

reminderBeforePeriod

nombre

Faux

Nombre JSON indiquant le nombre de jours avant la fin de l'abonnement d'essai, à partir duquel les notifications client commenceront. La valeur est exprimée en jours avec une valeur de -1 indiquant que ce n'est pas applicable.

onboardStatus

chaîne

Faux

Chaîne JSON indiquant l'état actuel de l'onboarding client. Les valeurs valides sont "not started", "in progress", "success", "failed". Les valeurs définies sont :

  • "non démarré"

  • "en cours"

  • "succès"

  • "échoué"

costPerAppUnit

nombre

Faux

Nombre JSON indiquant le coût par unité d'application. Pour une version d'essai, la valeur est 0. Unité : US dollars

costPerNamespaceUnit

nombre

Faux

Nombre JSON indiquant le coût par unité d'espace de noms. Pour une version d'essai, la valeur est 0. Unité : US dollars

les métadonnées

"type_astra_metadata_update"

Faux

Métadonnées spécifiques au client et au service associées à la ressource. Les valeurs définies sont :

  • Conforme au schéma de métadonnées Astra. Si aucune étiquette n'est spécifiée lors de la création, un objet de métadonnées sera créé sans étiquette. Si aucune étiquette n'est spécifiée lors de la mise à jour, les étiquettes de l'objet de métadonnées, creationTimestamp et createdBy, seront conservées sans modification.
Exemple de requête 
{
  "type": "application/astra-subscription",
  "version": "1.2",
  "customerProfileID": "2157047189",
  "paymentProfileID": "E7CEB0A9F1BECA32A02493E1B31D5955",
  "paymentExpiry": "2022-05-01T00:00:00Z"
}

Réponse

Status: 204, Indicates if the subscription resource was updated.

Réponse

Status: 401, Unauthorized
Nom Type Obligatoire Description

type

chaîne

Vrai

titre

chaîne

Vrai

détail

chaîne

Vrai

statut

chaîne

Vrai

identifiant de corrélation

chaîne

Faux
Exemple de réponse 
{
  "type": "https://astra.netapp.io/problems/3",
  "title": "Missing bearer token",
  "detail": "The request is missing the required bearer token.",
  "status": "401"
}

Réponse

Status: 400, Bad request
Nom Type Obligatoire Description

type

chaîne

Vrai

titre

chaîne

Vrai

détail

chaîne

Vrai

statut

chaîne

Vrai

identifiant de corrélation

chaîne

Faux

invalidFields

tableau["invalidFields"]

Faux

Liste des champs invalides du corps de la requête
Exemple de réponse 
{
  "type": "https://astra.netapp.io/problems/5",
  "title": "Invalid query parameters",
  "detail": "The supplied query parameters are invalid.",
  "status": "400"
}

Réponse

Status: 409, Conflict
Nom Type Obligatoire Description

type

chaîne

Vrai

titre

chaîne

Vrai

détail

chaîne

Vrai

statut

chaîne

Vrai

identifiant de corrélation

chaîne

Faux

invalidFields

tableau["invalidFields"]

Faux

Liste des champs invalides du corps de la requête
Exemple de réponse 
{
  "type": "https://astra.netapp.io/problems/10",
  "title": "JSON resource conflict",
  "detail": "The request body JSON contains a field that conflicts with an idempotent value.",
  "status": "409"
}

Réponse

Status: 403, Forbidden
Nom Type Obligatoire Description

type

chaîne

Vrai

titre

chaîne

Vrai

détail

chaîne

Vrai

statut

chaîne

Vrai

identifiant de corrélation

chaîne

Faux
Exemple de réponse 
{
  "type": "https://astra.netapp.io/problems/11",
  "title": "Operation not permitted",
  "detail": "The requested operation isn't permitted.",
  "status": "403"
}

Erreur

Status: 404, Not found
Nom Type Obligatoire Description

type

chaîne

Vrai

titre

chaîne

Vrai

détail

chaîne

Vrai

statut

chaîne

Vrai

identifiant de corrélation

chaîne

Faux
Exemple de réponse d'erreur 
{
  "type": "https://astra.netapp.io/problems/1",
  "title": "Resource not found",
  "detail": "The resource specified in the request URI wasn't found.",
  "status": "404"
}

Définitions

Voir les définitions

paymentAddress

Objet JSON contenant une collection de chaînes JSON spécifiant une adresse de facturation. Spécifié uniquement lorsque l'abonnement est refacturé. Si cette clé existe, les six chaînes JSON qu'elle contient seront présentes. Si rien n'a été fourni par l'utilisateur, la chaîne sera vide.

Nom Type Obligatoire Description

addressCountry

chaîne

Vrai

Chaîne JSON contenant le nom ou le code pays associé à l'adresse postale, conformément à la norme ISO 3166 Alpha-2. Les valeurs définies sont :

  • Longueur minimale : 0

  • Longueur maximale : 2

addressLocality

chaîne

Vrai

Chaîne JSON contenant la localité (par exemple, la ville) associée à l'adresse postale. Les valeurs définies sont :

  • Longueur minimale : 0

  • Longueur maximale : 63

addressRegion

chaîne

Vrai

Chaîne JSON contenant la région (par exemple, l'État) associée à l'adresse postale. Les valeurs définies sont :

  • Longueur minimale : 0

  • Longueur maximale : 63

postalCode

chaîne

Vrai

Chaîne JSON contenant le code postal associé à l'adresse postale. Les valeurs définies sont :

  • Longueur minimale : 0

  • Longueur maximale : 63

streetAddress1

chaîne

Vrai

Chaîne JSON contenant l'adresse de rue associée à l'adresse postale. Les valeurs définies sont :

  • Longueur minimale : 0

  • Longueur maximale : 63

streetAddress2

chaîne

Faux

Chaîne JSON contenant des informations complémentaires facultatives telles que l'adresse de rue, la boîte postale, et plus encore. Les valeurs définies sont :

  • Longueur minimale : 0

  • Longueur maximale : 63

type_astra_label

Nom Type Obligatoire Description

nom

chaîne

Vrai

valeur

chaîne

Vrai

type_astra_metadata_update

Métadonnées spécifiques au client et au service associées à la ressource. Les valeurs définies sont :

  • Conforme au schéma de métadonnées Astra. Si aucune étiquette n'est spécifiée lors de la création, un objet de métadonnées sera créé sans étiquette. Si aucune étiquette n'est spécifiée lors de la mise à jour, les étiquettes de l'objet de métadonnées, creationTimestamp et createdBy, seront conservées sans modification.

Nom Type Obligatoire Description

étiquettes

tableau["type_astra_label"]

Faux

CréationTimestamp

chaîne

Faux

ModificationTimestamp

chaîne

Faux

CreatedBy

chaîne

Faux

modifiedBy

chaîne

Faux

invalidParams

Nom Type Obligatoire Description

nom

chaîne

Vrai

Nom du paramètre de requête invalide

raison

chaîne

Vrai

Raison pour laquelle le paramètre de requête est invalide

invalidFields

Nom Type Obligatoire Description

nom

chaîne

Vrai

Nom du champ invalide du corps de la requête

raison

chaîne

Vrai

Raison pour laquelle le champ du corps de la requête est invalide