Questa pagina è stata tradotta dall'API Cloud Translation.

REST Resource: subscriptions

Risorsa: abbonamento
- Rappresentazione JSON
  - Rappresentazione JSON
Posti
- Rappresentazione JSON
RenewalSettings
- Rappresentazione JSON
Metodi

Risorsa: sottoscrizione

modello JSON per un abbonamento.

Rappresentazione JSON

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 } }

{
  "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 proprietà è obbligatoria. Poiché un `subscriptionId` cambia quando un abbonamento viene aggiornato, consigliamo di non utilizzare questo ID come chiave per i dati permanenti. Utilizza `subscriptionId` come descritto nell'articolo Recuperare 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 la sezione ID prodotto e SKU.
`creationTime`	`string (int64 format)` La proprietà `creationTime` corrisponde alla data di creazione dell'abbonamento. ed è espresso in millisecondi utilizzando il formato Epoch. Guarda un esempio di convertitore d'epoca.
`kind`	`string` Identifica la risorsa come sottoscrizione. Valore: `reseller#subscription`
`seats`	`object (Seats)` Questa proprietà è obbligatoria. Il numero e il limite di licenze di utenze 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 proprietà è facoltativa. Le informazioni sugli ordini di acquisto possono essere utilizzate dai rivenditori per il monitoraggio della loro azienda. Se viene assegnato 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 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 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 elenco di tutti i motivi di sospensione attuali per un abbonamento. È possibile che un abbonamento abbia molti motivi di sospensione simultanei che si sovrappongono. Il valore di `STATUS` di un abbonamento sarà `SUSPENDED` fino alla rimozione di tutte le sospensioni in attesa. Le possibili opzioni sono: `PENDING_TOS_ACCEPTANCE`: il cliente non ha eseguito l'accesso e non ha accettato i Termini di servizio del 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 per abuso o altro).
`customerDomain`	`string` Nome del dominio principale del cliente
`dealCode`	`string` Codice emesso da Google (massimo 100 caratteri) per prezzi scontati per i piani di abbonamento. Per poter usufruire della tariffa scontata, il codice deal deve essere incluso nelle richieste di `insert`. Questa proprietà è facoltativa. Se viene lasciata vuota, viene applicato il prezzo normale.
`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 modifica 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 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. Questo è il nome del piano dell'abbonamento. Per ulteriori informazioni sui piani di pagamento di Google, consulta i concetti delle API. I valori possibili sono: `ANNUAL_MONTHLY_PAY`: il piano di impegno annuale con pagamenti mensili. Attenzione: `ANNUAL_MONTHLY_PAY` viene restituito come `ANNUAL` in tutte le risposte dell'API. `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 in prova verrà sospeso dopo il 30° giorno senza costi se non è assegnato alcun piano di pagamento. Se chiami `changePlan`, verrà assegnato un piano di pagamento a una prova, ma il piano non verrà attivato. Una prova inizierà automaticamente il piano di pagamento assegnato al termine del 30° giorno di prova senza costi o subito dopo la chiamata al numero `startPaidService`. `FREE`: il piano senza costi è esclusivo per lo SKU di Cloud Identity e non prevede 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 è un piano con impegno annuale.
`plan.commitmentInterval`	`object` In questa versione dell'API, l'intervallo del piano di impegno annuale è di un anno. Nota : quando il valore `billingMethod` è `OFFLINE`, l'oggetto della proprietà di sottoscrizione `plan.commitmentInterval` viene omesso in tutte le risposte dell'API.
`plan.commitmentInterval.startTime`	`string (int64 format)` L'intervallo di un piano di impegno annuale è `startTime` in millisecondi utilizzando il formato UNIX Epoch. Guarda un esempio di convertitore d'epoca.
`plan.commitmentInterval.endTime`	`string (int64 format)` L'intervallo di un piano di impegno annuale è `endTime` in millisecondi utilizzando il formato UNIX Epoch. Guarda un esempio di convertitore d'epoca.
`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 delle API.
`trialSettings.isInTrial`	`boolean` Determina se il piano di un abbonamento prevede o meno 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 è espresso in millisecondi e utilizza il formato UNIX Epoch. Guarda un esempio di convertitore d'epoca.
`transferInfo`	`object` Informazioni relative al trasferimento di sola lettura per l'abbonamento. Per ulteriori informazioni, consulta l'articolo Recupero degli abbonamenti trasferibili per un cliente.
`transferInfo.transferabilityExpirationTime`	`string (int64 format)` La data e l'ora di scadenza del token di trasferimento o dell'intent da trasferire. Il tempo è espresso in millisecondi utilizzando il formato UNIX Epoch.
`transferInfo.minimumTransferableSeats`	`integer` Quando inserisci un abbonamento, questo è il numero minimo di utenze indicato 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 numero minimo di utenze è 20.
`transferInfo.currentLegacySkuId`	`string` Il `skuId` dell'abbonamento attualmente rivenduto. Il campo viene compilato 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 in 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 di un abbonamento. Il rivenditore può aggiungere altre licenze, ma una volta impostato, il `numberOfSeats` non può essere ridotto fino al rinnovo. La fatturazione al rivenditore viene calcolata in base al valore `numberOfSeats`, indipendentemente dal numero di licenze utente assegnate. Nota: gli abbonamenti a Google Workspace assegnano automaticamente una licenza a ogni utente.
`maximumNumberOfSeats`	`integer` Questa è una proprietà obbligatoria ed è riservata agli abbonamenti con piani `FLEXIBLE` o `TRIAL`. Questa proprietà 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. Nota: gli abbonamenti a G Suite assegnano automaticamente una licenza a ogni utente.
`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 equivale al conteggio numerico degli utenti restituiti dal metodo dell'API Enterprise License Manager: `listForProductAndSku`.
`kind`	`string` Identifica la risorsa come impostazione postazione di abbonamento. Valore: `subscriptions#seats`

RenewalSettings

Modello JSON per le impostazioni di rinnovo di un abbonamento.

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

Campi

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`

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`	Consente di aggiornare 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 diretto.
`get`	Consente di ottenere un abbonamento specifico.
`insert`	Crea o trasferisci una sottoscrizione.
`list`	Elenchi di abbonamenti gestiti dal rivenditore.
`startPaidService`	Trasferisci immediatamente un abbonamento di prova senza costi di 30 giorni a un abbonamento a un servizio a pagamento.
`suspend`	Sospende un abbonamento attivo.

REST Resource: subscriptions

Risorsa: sottoscrizione

Posti

RenewalSettings

Metodi

`activate`

`changePlan`

`changeRenewalSettings`

`changeSeats`

`delete`

`get`

`insert`

`list`

`startPaidService`

`suspend`