REST Resource: subscriptions

Risorsa: abbonamento

Modello JSON per un abbonamento.

Rappresentazione JSON 
{
  "customerId": string,
  "subscriptionId": string,
  "skuId": string,
  "creationTime": string,
  "kind": string,
  "seats": {
    object (Seats)
  },
  "renewalSettings": {
    object (RenewalSettings)
  },
  "purchaseOrderId": string,
  "status": string,
  "resourceUiUrl": string,
  "billingMethod": string,
  "suspensionReasons": [
    string
  ],
  "customerDomain": string,
  "dealCode": string,
  "skuName": string,
  "plan": {
    "planName": string,
    "isCommitmentPlan": boolean,
    "commitmentInterval": {
      "startTime": string,
      "endTime": string
    }
  },
  "trialSettings": {
    "isInTrial": boolean,
    "trialEndTime": string
  },
  "transferInfo": {
    "transferabilityExpirationTime": string,
    "minimumTransferableSeats": integer,
    "currentLegacySkuId": string
  }
}
Campi
customerId

string

Questa proprietà verrà sempre restituita in una risposta come identificatore univoco generato da Google. In una richiesta, questa proprietà può essere il dominio principale o l'identificatore univoco generato da Google.
subscriptionId

string

subscriptionId è l'identificatore dell'abbonamento ed è univoco per ciascun cliente. Questa è una proprietà obbligatoria. Dal momento che subscriptionId cambia in seguito all'aggiornamento di un abbonamento, consigliamo di non utilizzare questo ID come chiave per i dati permanenti. Utilizza l'subscriptionId come descritto in Recuperare tutti gli abbonamenti del rivenditore.
skuId

string

Una proprietà obbligatoria. Il skuId è un identificatore di sistema univoco per lo SKU di un prodotto assegnato a un cliente nell'abbonamento. Per i prodotti e gli SKU disponibili in questa versione dell'API, consulta la sezione ID prodotto e SKU.
creationTime

string (int64 format)

La proprietà creationTime indica la data di creazione dell'abbonamento. È in millisecondi utilizzando il formato Epoch. Guarda un esempio di convertitore epoca.
kind

string

Identifica la risorsa come una sottoscrizione. Valore: reseller#subscription
seats

object (Seats)

Questa è una proprietà obbligatoria. Il numero e il limite di licenze utente del piano.
renewalSettings

object (RenewalSettings)

Impostazioni di rinnovo per il piano di impegno annuale. Per informazioni più dettagliate, vedi le opzioni di rinnovo nel Centro assistenza per gli amministratori.
purchaseOrderId

string

Si tratta di una proprietà facoltativa. Le informazioni relative a questo ordine di acquisto consentono ai rivenditori di utilizzarli per il monitoraggio dell'utilizzo dell'azienda. Se viene specificato un valore purchaseOrderId, questo viene visualizzato nelle risposte dell'API e visualizzato nella fattura. La proprietà accetta fino a 80 caratteri di testo normale.
status

string

Si tratta di una proprietà facoltativa.
resourceUiUrl

string

URL alla pagina Abbonamenti del cliente nella Console di amministrazione. L'URL di sola lettura viene generato dal servizio API. Viene utilizzato se l'applicazione client richiede al cliente di completare un'attività utilizzando la pagina Abbonamenti della Console di amministrazione.
billingMethod

string

Campo di sola lettura che restituisce il metodo di fatturazione corrente per un abbonamento.
suspensionReasons[]

string

Campo di sola lettura contenente un'enumerazione di tutti i motivi di sospensione correnti di un abbonamento. È possibile che un abbonamento abbia molti motivi di sospensione simultanei e sovrapposti. Il valore di STATUS di un abbonamento è SUSPENDED fino alla rimozione di tutte le sospensioni in attesa.

Le possibili opzioni includono:

  • PENDING_TOS_ACCEPTANCE: il cliente non ha eseguito l'accesso e ha accettato i Termini di servizio per il rivenditore di G Suite.
  • RENEWAL_WITH_TYPE_CANCEL - L'impegno del cliente è terminato e il servizio è stato annullato al termine del periodo di validità.
  • RESELLER_INITIATED: una sospensione manuale richiamata da un rivenditore.
  • TRIAL_ENDED: la prova del cliente è scaduta senza un piano selezionato.
  • OTHER - il cliente è stato sospeso per un motivo interno di Google (ad esempio un abuso o altro).

customerDomain

string

Nome del dominio principale del cliente
dealCode

string

Codice emesso da Google (massimo 100 caratteri) per prezzi scontati sui piani di abbonamento. Il codice promozionale deve essere incluso nelle richieste di insert per poter usufruire della tariffa scontata. Questa proprietà è facoltativa. Se il criterio viene lasciato vuoto, vengono applicati i prezzi standard.
skuName

string

Nome visualizzato esterno in sola lettura per lo SKU di un prodotto assegnato a un cliente nell'abbonamento. I nomi degli SKU sono soggetti a modifiche a discrezione di Google. Per i prodotti e gli SKU disponibili in questa versione dell'API, consulta la sezione ID prodotto e SKU.
plan

object

La proprietà plan è obbligatoria. In questa versione dell'API, i piani G Suite sono il piano flessibile, il piano di impegno annuale e il piano di prova senza costi di 30 giorni. Per ulteriori informazioni sui piani di pagamento dell'API, consulta i concetti dell'API.
plan.planName

string

La proprietà planName è obbligatoria. Questo è il nome del piano dell'abbonamento. Per ulteriori informazioni sui piani di pagamento di Google, consulta i concetti dell'API.

I valori possibili sono:

  • ANNUAL_MONTHLY_PAY: il piano di impegno annuale con pagamenti mensili.
  • ANNUAL_YEARLY_PAY: il piano di impegno annuale con pagamenti annuali
  • FLEXIBLE: il piano flessibile
  • TRIAL: il piano di prova senza costi di 30 giorni. Un abbonamento di prova verrà sospeso dopo il 30° giorno senza costi se non viene assegnato un piano di pagamento. Chiamata al numero changePlan assegnerà un piano di pagamento a una prova, ma non attiverà il piano. Una prova inizierà automaticamente il piano di pagamento assegnato dopo il 30° giorno senza costi o subito dopo aver chiamato startPaidService.
  • FREE: il piano senza costi è esclusivo per lo SKU Cloud Identity e non prevede alcuna fatturazione.

plan.isCommitmentPlan

boolean

Il valore booleano della proprietà isCommitmentPlan identifica il piano come piano di impegno annuale:

  • true: il piano dell'abbonamento è un piano di impegno annuale.
  • false: il piano non è un piano di impegno annuale.
plan.commitmentInterval

object

In questa versione dell'API, l'intervallo del piano di impegno annuale è di un anno.

plan.commitmentInterval.startTime

string (int64 format)

Un intervallo di piani di impegno annuale startTime in millisecondi utilizzando il formato UNIX Epoch. Guarda un esempio di convertitore epoca.
plan.commitmentInterval.endTime

string (int64 format)

Un intervallo di piani di impegno annuali endTime in millisecondi utilizzando il formato UNIX Epoch. Guarda un esempio di convertitore epoca.
trialSettings

object

L'impegno annuale di G Suite e i piani di pagamento flessibili possono usufruire di una prova senza costi di 30 giorni. Per ulteriori informazioni, consulta i concetti dell'API.
trialSettings.isInTrial

boolean

Determina se il piano di un abbonamento sta usufruendo di una prova senza costi di 30 giorni o meno:

  • true: il piano è in prova.
  • false: il piano non è in prova.
trialSettings.trialEndTime

string (int64 format)

Data di fine della prova. Il valore è espresso in millisecondi nel formato UNIX Epoch. Guarda un esempio di convertitore epoca.
transferInfo

object

Informazioni relative al trasferimento di sola lettura per l'abbonamento. Per ulteriori informazioni, vedi Recuperare gli abbonamenti trasferibili per un cliente.
transferInfo.transferabilityExpirationTime

string (int64 format)

La scadenza del token o dell'intento di trasferimento. Il tempo è espresso in millisecondi utilizzando il formato UNIX Epoch.
transferInfo.minimumTransferableSeats

integer

Quando inserisci un abbonamento, questo è il numero minimo di utenze elencate nell'ordine di trasferimento per questo prodotto. Ad esempio, se il cliente ha 20 utenti, il rivenditore non può effettuare un ordine di trasferimento di 15 utenze. Il minimo è 20 posti.
transferInfo.currentLegacySkuId

string

Il skuId dell'attuale abbonamento rivenduto. Questo valore viene completato solo quando il cliente ha un abbonamento con uno SKU precedente e la risorsa di abbonamento viene compilata con il skuId dello SKU consigliato per il trasferimento.

Posti

Modello JSON per le utenze di abbonamento.

Rappresentazione JSON 
{
  "numberOfSeats": integer,
  "maximumNumberOfSeats": integer,
  "licensedNumberOfSeats": integer,
  "kind": string
}
Campi
numberOfSeats

integer

Questa è una proprietà obbligatoria ed è riservata agli abbonamenti con piani ANNUAL_MONTHLY_PAY e ANNUAL_YEARLY_PAY. Questa proprietà imposta il numero massimo di licenze assegnabili agli utenti che hanno sottoscritto un abbonamento. Il rivenditore può aggiungere altre licenze, ma, una volta impostato, il numberOfSeats non può essere ridotto fino al rinnovo. Il rivenditore riceve le fatture in base al valore di numberOfSeats, indipendentemente dal numero di licenze utente assegnate.

maximumNumberOfSeats

integer

Questa è una proprietà obbligatoria ed è riservata agli abbonamenti con piani FLEXIBLE o TRIAL. Questa proprietà imposta il numero massimo di utenti autorizzati in un abbonamento. Questa quantità può essere aumentata fino al limite massimo definito nel contratto del rivenditore. La quantità minima corrisponde al numero corrente di utenti nell'account cliente.

licensedNumberOfSeats

integer

Campo di sola lettura contenente il numero corrente di utenti a cui è stata assegnata una licenza per il prodotto definito in skuId. Il valore di questo campo equivale al conteggio numerico degli utenti restituiti dal metodo API Enterprise License Manager: listForProductAndSku.
kind

string

Identifica la risorsa come impostazione di postazione di abbonamento. Valore: subscriptions#seats

RenewalSettings

Modello JSON per le impostazioni di rinnovo dell'abbonamento.

Rappresentazione JSON 
{
  "renewalType": string,
  "kind": string
}
Campi
renewalType

string

Impostazioni di rinnovo per il piano di impegno annuale. Per informazioni più dettagliate, vedi le opzioni di rinnovo nel Centro assistenza per gli amministratori. Al momento di rinnovare un abbonamento, renewalType è una proprietà obbligatoria.
kind

string

Identifica la risorsa come impostazione di rinnovo dell'abbonamento. Valore: subscriptions#renewalSettings

Metodi

activate

 Attiva un abbonamento precedentemente sospeso dal rivenditore.

changePlan

 Aggiorna un piano di abbonamento.

changeRenewalSettings

 Aggiorna le impostazioni di rinnovo di una licenza utente.

changeSeats

 Aggiorna le impostazioni delle licenze utente di un abbonamento.

delete

 Annulla, sospende o trasferisce un abbonamento a Direct.

get

 Riceve un abbonamento specifico.

insert

 Crea o trasferisce un abbonamento.

list

 Elenchi degli abbonamenti gestiti dal rivenditore.

startPaidService

 Sposta immediatamente un abbonamento di prova senza costi di 30 giorni a un abbonamento a un servizio a pagamento.

suspend

 Sospende un abbonamento attivo.