Skip to main content
Astra Automation
La versione in lingua italiana fornita proviene da una traduzione automatica. Per eventuali incoerenze, fare riferimento alla versione in lingua inglese.

Modificare un abbonamento

PDF

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

Sostituisce l'intera risorsa memorizzata con il corpo della richiesta JSON fornito, preservando i valori chiave non modificabili dall'utente.

Effetti collaterali

  • Se l'utente annulla l'abbonamento, l'endpoint PUT deve essere chiamato con "status": "inactive".

  • Quando lo stato viene impostato su "inattivo", gli addebiti in sospeso per questo abbonamento vengono inviati a Zuora e l'abbonamento Zuora verrà contrassegnato come "inattivo" in qualche modo.

Parametri

Nome Tipo In Obbligatorio Descrizione

ID account

stringa

percorso

Vero

ID della risorsa account contenitore

  • esempio: {{.Account}}

subscription_id

stringa

percorso

Vero

ID della raccolta di abbonamenti da elencare

Corpo della richiesta

Sostituisce l'intera risorsa memorizzata con il corpo della richiesta JSON fornito, preservando i valori chiave non modificabili dall'utente.

Effetti collaterali

  • Se l'utente annulla l'abbonamento, l'endpoint PUT deve essere chiamato con "status": "inactive".

  • Quando lo stato viene impostato su "inattivo", gli addebiti in sospeso per questo abbonamento vengono inviati a Zuora e l'abbonamento Zuora verrà contrassegnato come "inattivo" in qualche modo.

Nome Tipo Obbligatorio Descrizione

tipo

stringa

Vero

Tipo di media della risorsa. I valori definiti sono:

  • "application/astra-subscription"

versione

stringa

Vero

Versione della risorsa. I valori definiti sono:

  • "1,0"

  • "1,1"

  • "1,2"

id

stringa

Falso

Identificatore univoco globale della risorsa. I valori definiti sono:

  • Conforme allo schema UUIDv4

customerProfileID

stringa

Falso

La stringa JSON contenente l'ID del profilo del cliente da "Authorize.net", che è stata richiamata dall'interfaccia utente, non è impostata per il periodo di prova. Restituisce una stringa vuota durante l'operazione di lettura, se non impostata. I valori definiti sono:

  • Lunghezza minima: 0

  • Lunghezza massima: 63

paymentFirstName

stringa

Falso

Stringa JSON contenente un nome proprio esteso specificato dall'utente, utilizzato per la fatturazione dei pagamenti. Specificato solo quando l'abbonamento viene rinnovato. I valori definiti sono:

  • Lunghezza minima: 1

  • Lunghezza massima: 63

paymentLastName

stringa

Falso

Stringa JSON contenente il cognome esteso specificato dall'utente, utilizzato per la fatturazione dei pagamenti. Specificato solo al momento del rinnovo dell'abbonamento. I valori definiti sono:

  • Lunghezza minima: 1

  • Lunghezza massima: 63

paymentAddress

"paymentAddress"

Falso

Oggetto JSON contenente una raccolta di stringhe JSON che specificano un indirizzo di fatturazione. Specificato solo quando l'abbonamento viene rifatturato. Se questa chiave esiste, saranno presenti tutte e sei le stringhe JSON contenute. Se non è stato fornito nulla dall'utente, la stringa sarà vuota.

paymentProfileID

stringa

Falso

Stringa JSON contenente l'ID del profilo di pagamento da "Authorize.net" che è stato richiamato dall'interfaccia utente, non impostato per il grace period. Restituisce una stringa vuota durante l'operazione di lettura se non impostato. I valori definiti sono:

  • Lunghezza minima: 0

  • Lunghezza massima: 63

paymentExpiry

stringa

Falso

Stringa JSON contenente un timestamp che indica quando il metodo di pagamento scade. Questo è ottenuto da authorize.net(http://authorize.net e viene impostato dall'interfaccia utente. I valori definiti sono:

  • Conforme allo schema data/ora ISO-8601 Questo campo non viene restituito per i periodi di prova.

purchaseOrderNumber

stringa

Falso

Stringa JSON contenente il numero dell'ordine di acquisto per il metodo di pagamento. I valori definiti sono:

  • Lunghezza minima: 1

  • Lunghezza massima: 31

marketplace

stringa

Falso

Stringa JSON che indica il marketplace per un account in cui verranno registrati i pagamenti. Valori definiti:

  • "netapp"

  • "azure"

  • "aws"

  • "gcp"

licenseSN

stringa

Falso

Stringa JSON contenente il numero di serie della licenza per il metodo di pagamento. I valori definiti sono:

  • Lunghezza minima: 1

  • Lunghezza massima: 31

termini

stringa

Falso

Stringa JSON che indica il livello attuale dell'account. I valori definiti sono:

  • "prova"

  • "pagato"

stato

stringa

Falso

Stringa JSON che indica lo stato attuale dell'abbonamento. I valori definiti sono:

  • "attivo"

  • "inattivo"

appLimit

numero

Falso

Numero JSON che indica il limite di applicazioni per questo abbonamento. Il valore -1 indica nessun limite.

namespaceLimit

numero

Falso

Numero JSON che indica il limite di namespace per questo abbonamento. Il valore -1 indica nessun limite.

subscriptionPeriod

numero

Falso

Numero JSON che indica il periodo di abbonamento. Il valore -1 indica nessun limite. Unità: giorni

gracePeriod

numero

Falso

Numero JSON che indica il grace period successivo alla scadenza del periodo di prova o all'annullamento di un abbonamento a pagamento. Unità: giorni

reminderBeforePeriod

numero

Falso

Numero JSON che indica il numero di giorni prima della fine del periodo di prova in cui inizieranno le notifiche al cliente. Il valore è espresso in giorni con un valore di -1 che indica che non è applicabile.

onboardStatus

stringa

Falso

Stringa JSON che indica lo stato attuale dell'onboarding del cliente. I valori validi sono "non avviato", "in corso", "riuscito", "fallito". I valori definiti sono:

  • "non avviato"

  • "in corso"

  • "successo"

  • "fallito"

costPerAppUnit

numero

Falso

Numero JSON che indica il costo per unità dell'app. Per una versione di prova, il valore è 0. Unità: dollari statunitensi

costPerNamespaceUnit

numero

Falso

Numero JSON che indica il costo per unità di namespace. Per la versione di prova, il valore è 0. Unità: dollari statunitensi

metadati

"aggiornamento dei metadati di tipo Astra"

Falso

Metadati specificati dal client e dal servizio associati alla risorsa. I valori definiti sono:

  • Conforme allo schema dei metadati Astra. Se non specificato in fase di creazione, verrà creato un oggetto metadati senza etichette. Se non specificato in fase di aggiornamento, le etichette dell'oggetto metadati, creationTimestamp e createdBy, verranno conservate senza modifiche.
Esempio di richiesta 
{
  "type": "application/astra-subscription",
  "version": "1.2",
  "customerProfileID": "2157047189",
  "paymentProfileID": "E7CEB0A9F1BECA32A02493E1B31D5955",
  "paymentExpiry": "2022-05-01T00:00:00Z"
}

Risposta

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

Risposta

Status: 401, Unauthorized
Nome Tipo Obbligatorio Descrizione

tipo

stringa

Vero

titolo

stringa

Vero

dettaglio

stringa

Vero

stato

stringa

Vero

ID correlazione

stringa

Falso
Risposta tipo 
{
  "type": "https://astra.netapp.io/problems/3",
  "title": "Missing bearer token",
  "detail": "The request is missing the required bearer token.",
  "status": "401"
}

Risposta

Status: 400, Bad request
Nome Tipo Obbligatorio Descrizione

tipo

stringa

Vero

titolo

stringa

Vero

dettaglio

stringa

Vero

stato

stringa

Vero

ID correlazione

stringa

Falso

invalidFields

vettore["invalidFields"]

Falso

Elenco dei campi non validi del corpo della richiesta
Risposta tipo 
{
  "type": "https://astra.netapp.io/problems/5",
  "title": "Invalid query parameters",
  "detail": "The supplied query parameters are invalid.",
  "status": "400"
}

Risposta

Status: 409, Conflict
Nome Tipo Obbligatorio Descrizione

tipo

stringa

Vero

titolo

stringa

Vero

dettaglio

stringa

Vero

stato

stringa

Vero

ID correlazione

stringa

Falso

invalidFields

vettore["invalidFields"]

Falso

Elenco dei campi non validi del corpo della richiesta
Risposta tipo 
{
  "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"
}

Risposta

Status: 403, Forbidden
Nome Tipo Obbligatorio Descrizione

tipo

stringa

Vero

titolo

stringa

Vero

dettaglio

stringa

Vero

stato

stringa

Vero

ID correlazione

stringa

Falso
Risposta tipo 
{
  "type": "https://astra.netapp.io/problems/11",
  "title": "Operation not permitted",
  "detail": "The requested operation isn't permitted.",
  "status": "403"
}

Errore

Status: 404, Not found
Nome Tipo Obbligatorio Descrizione

tipo

stringa

Vero

titolo

stringa

Vero

dettaglio

stringa

Vero

stato

stringa

Vero

ID correlazione

stringa

Falso
Esempio di risposta di errore 
{
  "type": "https://astra.netapp.io/problems/1",
  "title": "Resource not found",
  "detail": "The resource specified in the request URI wasn't found.",
  "status": "404"
}

Definizioni

Vedi definizioni

paymentAddress

Oggetto JSON contenente una raccolta di stringhe JSON che specificano un indirizzo di fatturazione. Specificato solo quando l'abbonamento viene rifatturato. Se questa chiave esiste, saranno presenti tutte e sei le stringhe JSON contenute. Se non è stato fornito nulla dall'utente, la stringa sarà vuota.

Nome Tipo Obbligatorio Descrizione

addressCountry

stringa

Vero

Stringa JSON contenente il nome o il codice del paese associato all'indirizzo postale, come specificato nello standard ISO 3166 Alpha-2. I valori definiti sono:

  • Lunghezza minima: 0

  • Lunghezza massima: 2

addressLocality

stringa

Vero

Stringa JSON contenente la località (ad esempio, la città) associata all'indirizzo postale. I valori definiti sono:

  • Lunghezza minima: 0

  • Lunghezza massima: 63

addressRegion

stringa

Vero

Stringa JSON contenente la regione (ad esempio, stato) associata all'indirizzo postale. I valori definiti sono:

  • Lunghezza minima: 0

  • Lunghezza massima: 63

postalCode

stringa

Vero

Stringa JSON contenente il codice postale associato all'indirizzo postale. I valori definiti sono:

  • Lunghezza minima: 0

  • Lunghezza massima: 63

streetAddress1

stringa

Vero

Stringa JSON contenente l'indirizzo stradale associato all'indirizzo postale. I valori definiti sono:

  • Lunghezza minima: 0

  • Lunghezza massima: 63

streetAddress2

stringa

Falso

Stringa JSON contenente informazioni aggiuntive facoltative sull'indirizzo stradale, casella postale e altro. I valori definiti sono:

  • Lunghezza minima: 0

  • Lunghezza massima: 63

etichetta tipo_astra

Nome Tipo Obbligatorio Descrizione

nome

stringa

Vero

valore

stringa

Vero

aggiornamento dei metadati di tipo Astra

Metadati specificati dal client e dal servizio associati alla risorsa. I valori definiti sono:

  • Conforme allo schema dei metadati Astra. Se non specificato in fase di creazione, verrà creato un oggetto metadati senza etichette. Se non specificato in fase di aggiornamento, le etichette dell'oggetto metadati, creationTimestamp e createdBy, verranno conservate senza modifiche.

Nome Tipo Obbligatorio Descrizione

etichette

vettore["etichetta tipo_astra"]

Falso

CreationTimestamp

stringa

Falso

ModificationTimestamp

stringa

Falso

CreatedBy

stringa

Falso

modifiedBy

stringa

Falso

invalidParams

Nome Tipo Obbligatorio Descrizione

nome

stringa

Vero

Nome del parametro di query non valido

motivo

stringa

Vero

Motivo per cui il parametro di query non è valido

invalidFields

Nome Tipo Obbligatorio Descrizione

nome

stringa

Vero

Nome del campo del corpo della richiesta non valido

motivo

stringa

Vero

Motivo per cui il campo del corpo della richiesta non è valido