REST Resource: subscriptions

Risorsa: Abbonamento

Modello JSON per una sottoscrizione.

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 ogni cliente. Questa è una proprietà obbligatoria. Poiché un subscriptionId cambia quando un abbonamento viene aggiornato, ti consigliamo di non utilizzare questo ID come chiave per i dati permanenti. Utilizza subscriptionId come descritto in Recupero di tutti gli abbonamenti del rivenditore.
skuId

string

Una proprietà obbligatoria. 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 ID prodotto e SKU.
creationTime

string (int64 format)

La proprietà creationTime è la data di creazione dell'abbonamento. È in millisecondi utilizzando il formato Epoch. Vedi un esempio di convertitore di epoche.
kind

string

Identifica la risorsa come Abbonamento. Valore: reseller#subscription
seats

object (Seats)

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

object (RenewalSettings)

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

string

Questa è una proprietà facoltativa. Queste informazioni sull'ordine di acquisto (OA) sono destinate all'utilizzo dei rivenditori per il monitoraggio dell'utilizzo della loro azienda. Se viene specificato un valore purchaseOrderId, questo viene visualizzato nelle risposte dell'API e nella fattura. La proprietà accetta fino a 80 caratteri di testo normale.
status

string

Questa è 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 la tua applicazione client richiede al cliente di completare un'attività utilizzando la pagina Abbonamenti nella Console di amministrazione.
billingMethod

string

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

string

Campo di sola lettura contenente un enumerabile di tutti i motivi di sospensione attuali di un abbonamento. È possibile che un abbonamento abbia molti motivi di sospensione simultanei e sovrapposti. Il valore STATUS di un abbonamento è SUSPENDED finché non vengono rimosse tutte le sospensioni in attesa.

Le opzioni possibili includono:

  • PENDING_TOS_ACCEPTANCE: il cliente non ha eseguito l'accesso e non ha accettato i Termini di servizio di G Suite rivenduto.
  • 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 invocata da un rivenditore.
  • TRIAL_ENDED: la prova del cliente è scaduta senza che sia stato selezionato un piano.
  • OTHER: il cliente è stato sospeso per un motivo interno di Google (ad es. abuso o altro).

customerDomain

string

Nome di dominio principale del cliente
dealCode

string

Codice emesso da Google (massimo 100 caratteri) per i prezzi scontati dei piani di abbonamento. Il codice promozionale deve essere incluso nelle richieste insert per ricevere la tariffa scontata. Questa proprietà è facoltativa. Se viene lasciata vuota, vengono applicati i prezzi regolari.
skuName

string

Nome visualizzato esterno di 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 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 con 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. Si tratta del 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 con impegno annuale e pagamenti mensili.
  • ANNUAL_YEARLY_PAY: il piano con impegno annuale e pagamenti annuali
  • FLEXIBLE - Il piano flessibile
  • TRIAL: il piano di prova senza costi di 30 giorni. Un abbonamento in prova verrà sospeso dopo il 30° giorno senza costi se non viene assegnato alcun piano di pagamento. Se chiami changePlan, verrà assegnato un piano di pagamento a una prova, ma il piano non verrà attivato. Il piano di pagamento assegnato inizierà automaticamente dopo il 30° giorno di prova senza costi o immediatamente dopo la chiamata al numero startPaidService.
  • FREE: il piano senza costi è esclusivo per lo SKU Cloud Identity e non comporta alcuna fatturazione.

plan.isCommitmentPlan

boolean

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

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

object

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

plan.commitmentInterval.startTime

string (int64 format)

startTime dell'intervallo di un piano di impegno annuale in millisecondi utilizzando il formato Epoch di UNIX. Vedi un esempio di convertitore di epoche.
plan.commitmentInterval.endTime

string (int64 format)

endTime dell'intervallo di un piano di impegno annuale in millisecondi utilizzando il formato Epoch di UNIX. Vedi un esempio di convertitore di epoche.
trialSettings

object

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

boolean

Determina se per il piano di un abbonamento è in corso una prova senza costi di 30 giorni:

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

string (int64 format)

Data di fine del periodo di prova. Il valore è in millisecondi utilizzando il formato dell'epoca di Unix. Guarda un esempio di convertitore di epoche.
transferInfo

object

Informazioni relative al trasferimento in sola lettura per l'abbonamento. Per ulteriori informazioni, vedi Recuperare le iscrizioni trasferibili per un cliente.
transferInfo.transferabilityExpirationTime

string (int64 format)

La data e l'ora di scadenza del token di trasferimento o dell'intenzione di trasferimento. Il tempo è in millisecondi utilizzando il formato dell'epoca di Unix.
transferInfo.minimumTransferableSeats

integer

Quando inserisci un abbonamento, si tratta del numero minimo di licenze 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 licenze. Il numero minimo di posti è 20.
transferInfo.currentLegacySkuId

string

Il skuId dell'abbonamento rivenduto attuale. Viene compilato solo se il cliente ha un abbonamento con uno SKU precedente e la risorsa dell'abbonamento è compilata con il skuId dello SKU consigliato per il trasferimento.

Posti

Modello JSON per i posti dell'abbonamento.

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

integer

Questa è una proprietà obbligatoria ed è esclusiva per gli abbonamenti con i piani ANNUAL_MONTHLY_PAY e ANNUAL_YEARLY_PAY. Imposta il numero massimo di licenze assegnabili agli utenti di un abbonamento. Il rivenditore può aggiungere altre licenze, ma una volta impostato, il valore numberOfSeats non può essere ridotto fino al rinnovo. La fatturazione al rivenditore avviene in base al valore numberOfSeats, indipendentemente dal numero di licenze utente assegnate.

maximumNumberOfSeats

integer

Si tratta di una proprietà obbligatoria ed è esclusiva degli abbonamenti con piani FLEXIBLE o TRIAL. Imposta il numero massimo di utenti con licenza consentiti in un abbonamento. Questa quantità può essere aumentata fino al limite massimo definito nel contratto del rivenditore. La quantità minima è il numero corrente di utenti nell'account cliente.

licensedNumberOfSeats

integer

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

string

Identifica la risorsa come impostazione del posto dell'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 con impegno annuale. Per informazioni più dettagliate, consulta le opzioni di rinnovo nel Centro assistenza per gli amministratori. Quando rinnovi 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

 Annullamento, sospensione o trasferimento di un abbonamento a Direct.

get

 Riceve un abbonamento specifico.

insert

 Crea o trasferisce un abbonamento.

list

 Elenchi di abbonamenti gestiti dal rivenditore.

startPaidService

 Passare immediatamente da un abbonamento con prova senza costi di 30 giorni a un abbonamento a un servizio a pagamento.

suspend

 Sospende un abbonamento attivo.