Recuperare e aggiornare un abbonamento

Dopo aver recuperato un abbonamento, puoi utilizzare le informazioni presenti nel risposta corretta a modificare lo stato dell'abbonamento o aggiornare l'abbonamento. Questa pagina illustra i diversi modi in cui puoi recuperare e aggiornare una sottoscrizione.

Recuperare una sottoscrizione

Per recuperare un abbonamento ordinato o trasferito, utilizza dopo GETrichiesta HTTP.

GET https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID

Sostituisci quanto segue:

Questa operazione non ha parametri nel corpo della richiesta.

Una risposta corretta restituisce uno stato HTTP 200 del codice e le impostazioni dell'abbonamento. Nella risposta di esempio che segue, La proprietà isInTrial è false ma non sono presenti trialEndTime, nel senso che il cliente non è mai stato in una Prova senza costi di 30 giorni con questo piano.

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "skuId": "1010020028",
  "billingMethod": "ONLINE",
  "creationTime": "1331647980142",
  "plan": {
    "planName": "ANNUAL",
    "isCommitmentPlan": true,
    "commitmentInterval": {
      "startTime": "1331647980142",
      "endTime": "1363183980142"
    }
  },
  "seats": {
    "kind": "subscriptions#seats",
    "numberOfSeats": 10,
    "licensedNumberOfSeats": 10
  },
  "trialSettings": {
    "isInTrial": false
  },
  "renewalSettings": {
    "kind": "subscriptions#renewalSettings",
    "renewalType": "RENEW_CURRENT_USERS_MONTHLY_PAY"
  },
  "purchaseOrderId": "example.com_annual_1",
  "status": "ACTIVE",
  "resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
  "skuName": "Google Workspace Business Standard"
}

Recupera tutti gli abbonamenti per un cliente

Per recuperare tutti gli abbonamenti di un determinato cliente rivenditore che sono stati ordinato o trasferito correttamente, utilizza la seguente richiesta HTTP GET e includi il token di autorizzazione:

GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions?customerId=CUSTOMER_ID value&pageToken=START_DATE&maxResults=MAX_NUMBER

Sostituisci quanto segue:

  • CUSTOMER_ID: il dominio principale del cliente nome utente o l'identificatore univoco del cliente.
  • START_DATE: la data di inizio nel formato YYYY-MM-DD.
  • MAX_NUMBER: il numero massimo di risultati restituiti in una pagina di risposta.

Questa operazione non ha parametri nel corpo della richiesta.

Una risposta corretta restituisce un codice di stato HTTP 200 e un elenco delle gli abbonamenti e le impostazioni del cliente. L'elenco degli abbonamenti potrebbe includere prodotti non gestiti in questa versione dell'API dei rivenditori.

Se non gestisci questo cliente non è gestito, viene visualizzato un errore 403 "Forbidden" restituito.

Recupera tutti gli abbonamenti trasferibili per un cliente

Per recuperare tutti gli abbonamenti di un cliente che potrebbero essere trasferito alla gestione del rivenditore, usa la seguente richiesta HTTP GET e includere il token di autorizzazione. La customerId è obbligatorio ed è l'identificatore univoco del cliente restituito quando il recupero dell'account di un cliente del rivenditore. customerAuthToken è un token di trasferimento fornito dal cliente specifiche per il tuo ID rivenditore. Una volta generato dal cliente, è valido per 30 giorni. Per saperne di più su come i clienti generano il token, consulta Trasferisci il tuo account Google Workspace a un rivenditore.

GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions?customerId=CUSTOMER_ID&customerAuthToken=AUTH_TOKEN&pageToken=START_DATE&maxResults=MAX_NUMBER

Sostituisci quanto segue:

  • CUSTOMER_ID: il dominio principale del cliente nome utente o l'identificatore univoco del cliente.
  • AUTH_TOKEN: un token di trasferimento fornito dal tuo cliente specifico per il tuo ID rivenditore. Dopo che è stato generato cliente, è valida per 30 giorni. Per ulteriori informazioni su come i clienti generare il token, consultare Trasferisci il tuo account Google Workspace a un rivenditore. Se questo valore non è valido o è scaduto, la risposta dell'API restituisce un 403 "Forbidden" errore.
  • START_DATE: la data di inizio nel formato YYYY-MM-DD.
  • MAX_NUMBER: il numero massimo di risultati restituiti in una pagina di risposta.

Questa operazione non ha parametri nel corpo della richiesta.

Una risposta corretta restituisce un codice di stato HTTP 200 e un elenco delle gli abbonamenti trasferibili del cliente con la data di scadenza del trasferimento e il numero minimo di utenze necessario nell'ordine di trasferimento. Un cliente potrebbe sospendere abbonamenti aggiuntivi che non sono trasferibili.

{
  "kind": "reseller#subscriptions",
  "subscriptions": [
    {
      "kind": "subscriptions#subscription",
      "customerId": "custId-6543",
      "subscriptionId": "432",
      "skuId": "1010020028",
      "billingMethod": "ONLINE",
      "creationTime": "1331647980142",
      "plan": {
        "planName": "ANNUAL",
        "isCommitmentPlan": true,
        "commitmentInterval": {
          "startTime": "1331647980142",
          "endTime": "1363183980142"
        }
      },
      "seats": {
        "kind": "subscriptions#seats",
        "numberOfSeats": 10,
        "maximumNumberOfSeats": 500,
        "licensedNumberOfSeats": 10
      },
      "trialSettings": {
        "isInTrial": false
      },
      "renewalSettings": {
        "kind": "subscriptions#renewalSettings",
        "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
      },
      "transferInfo": {
        "transferabilityExpirationTime": "1333183980142",
        "minimumTransferableSeats": "20"
      },
      "purchaseOrderId": "PO_890",
      "status": "ACTIVE",
      "resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
      "skuName": "Google Workspace Business Standard"
    },
    {
      "kind": "subscriptions#subscription",
      "customerId": "custId-6543",
      "subscriptionId": "140",
      "skuId": "1010020028",
      "creationTime": "1329389322728",
      "plan": {
        "planName": "FLEXIBLE",
        "isCommitmentPlan": false
      },
      "seats": {
        "kind": "subscriptions#seats",
        "maximumNumberOfSeats": 50
        "licensedNumberOfSeats": 10
      },
      "trialSettings": {
        "isInTrial": false,
        "trialEndTime": "1331877480016"
      },
      "renewalSettings": {
        "kind": "subscriptions#renewalSettings",
        "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
      },
      "transferInfo": {
        "transferabilityExpirationTime": "1333183780159",
        "minimumTransferableSeats": "10"
      },
      "purchaseOrderId": "",
      "status": "ACTIVE",
      "resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
      "skuName": "Google Workspace Business Standard"
    },
  ],
  "nextPageToken": "token"
}

Se prevedi di trasferire queste sottoscrizioni utilizzando il batch trasferire tutti gli abbonamenti. Trasferimento di ogni abbonamento i risultati uno alla volta restituisce un errore. Inoltre, l'operazione in batch trasferisce abbonamenti con stato ACTIVE. Per ulteriori informazioni, vedi Trasferire un abbonamento.

Recupera tutti gli abbonamenti del rivenditore

Per recuperare tutti gli ordini o trasferiti di un rivenditore utilizza la seguente richiesta HTTP GET e includi il token di autorizzazione. 

GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions?customerNamePrefix=PREFIX &pageToken=TOKEN&maxResults=MAX_NUMBER

Sostituisci quanto segue:

  • PREFIX: l'inizio del nome del cliente la cui gli abbonamenti che stai cercando.
  • TOKEN: un token che identifica una pagina specifica di che il server deve restituire.
  • MAX_NUMBER: il numero massimo di risultati restituiti in una pagina di risposta.

Questa operazione può utilizzare l'ambito di accesso di sola lettura OAuth. La customerNamePrefix, pageToken e maxResults sono stringhe di query facoltative.

L'esempio seguente recupera tutti gli abbonamenti di un rivenditore che appartengono a clienti il cui nome inizia con "esame":

GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions?customerNamePrefix=exam

{
  "kind": "reseller#subscriptions",
  "subscriptions": [
    {
      "kind": "subscriptions#subscription",
      "customerId": "C0123456",
      "subscriptionId": "123",
      "skuId": "1010020028",
      "creationTime": "1331647980142",
      "billingMethod": "ONLINE",
      "plan": {
        "planName": "ANNUAL",
        "isCommitmentPlan": true,
        "commitmentInterval": {
          "startTime": "1331647980142",
          "endTime": "1363183980142"
        }
      },
      "seats": {
        "kind": "subscriptions#seats",
        "numberOfSeats": 10,
        "licensedNumberOfSeats": 10
      },
      "trialSettings": {
        "isInTrial": false
      },
      "renewalSettings": {
        "kind": "subscriptions#renewalSettings",
        "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
      },
      "purchaseOrderId": "PO_135",
      "status": "ACTIVE",
      "resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
      "skuName": "Google Workspace Business Standard"
    },
    {
      "kind": "subscriptions#subscription",
      "customerId": "custId-5678",
      "subscriptionId": "1404686",
      "skuId": "1010020028",
      "billingMethod": "ONLINE",
      "creationTime": "1329389322728",
      "plan": {
        "planName": "FLEXIBLE",
        "isCommitmentPlan": false
      },
      "seats": {
        "kind": "subscriptions#seats",
        "maximumNumberOfSeats": 50,
        "licensedNumberOfSeats": 10
      },
      "trialSettings": {
        "isInTrial": false,
        "trialEndTime": "1331877480016"
      },
      "renewalSettings": {
        "kind": "subscriptions#renewalSettings",
        "renewalType": "AUTO_RENEW"
      },
      "purchaseOrderId": "",
      "status": "ACTIVE",
      "resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
      "skuName": "Google Workspace Business Standard"
    },
  ],
  "nextPageToken": "token"
}

Aggiornare un piano di abbonamento

L'aggiornamento dei piani Google Workspace varia a seconda del piano. Prima di eseguire l'aggiornamento un piano, considera quanto segue:

  • Quando crei un abbonamento e il cliente è idoneo, i può essere una prova di 30 giorni. Sia l'offerta flessibile che quella annuale i piani di pagamento dell'impegno possono essere prove senza costi di 30 giorni. Durante la prova, può modificare il piano di pagamento dell'abbonamento in flessibile o annuale di Google Cloud tutte le volte che è necessario. Ma al termine della prova e del piano attivo, l'aggiornamento del piano segue le stesse regole degli altri abbonamenti piani attivi. Per trasferire immediatamente un abbonamento di prova a un piano attivo, iniziare un servizio a pagamento da un abbonamento di prova senza costi di 30 giorni. Per ulteriori informazioni sulla prova di 30 giorni e sulle regole di qualificazione del cliente, consulta Centro assistenza per gli amministratori.

  • Puoi aggiornare un piano flessibile in un piano con impegno annuale.

  • Non puoi aggiornare un piano con impegno annuale.

  • Non tutti i piani funzionano con tutti i prodotti. Per ulteriori informazioni su quali utilizzati dai piani, vedi Prodotti e SKU.

Per aggiornare un piano per una prova di 30 giorni o un abbonamento con piano flessibile a un piano annuale utilizza la seguente richiesta HTTP POST:

POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID/changePlan

Sostituisci quanto segue:

L'esempio seguente aggiorna la sottoscrizione con subscriptionId con il valore 123. Il customerId è C0123456.

POST https://reseller.googleapis.com/apps/reseller/v1/customers/C0123456/subscriptions/123/changePlan

Il corpo della richiesta contiene il seguente codice:

{
  "kind": "reseller#changePlanRequest",
  "planName": "ANNUAL_MONTHLY_PAY",
  "seats": {
    "kind": "subscriptions#seats",
    "numberOfSeats": 10
  },
  "purchaseOrderId": "123_March2012"
}

Una risposta corretta restituisce un codice di stato HTTP 201 e la risposta aggiornata impostazioni dei piani di abbonamento:

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "skuId": "1010020028",
  "creationTime": "1331647980142",
  "plan": {
    "planName": "ANNUAL",
    "isCommitmentPlan": true,
    "commitmentInterval": {
      "startTime": "1331647980142",
      "endTime": "1363183980142"
    }
  },
  "seats": {
    "kind": "subscriptions#seats",
    "numberOfSeats": 10,
    "licensedNumberOfSeats": 10
  },
  "trialSettings": {
    "isInTrial": false
  },
  "renewalSettings": {
    "kind": "subscriptions#renewalSettings",
    "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
  },
  "purchaseOrderId": "123_March2012",
  "status": "ACTIVE",
  "skuName": "Google Workspace Business Standard"
}

Aggiornare le utenze di un abbonamento

L'aggiornamento di un abbonamento a un piano con impegno annuale utilizza un abbonamento diverso rispetto all'aggiornamento dell'abbonamento a un piano flessibile di Google Workspace.

Aggiornare le utenze per l'abbonamento a un piano annuale

Per aggiornare le impostazioni delle licenze utente di un abbonamento con piano annuale, utilizza quanto segue Richiesta HTTP POST:

POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID/changeSeats

Sostituisci quanto segue:

L'esempio seguente aggiorna la sottoscrizione con il 123 subscriptionId. La customerId è C0123456. Il corpo della richiesta varia a seconda del tipo di piano:

POST https://reseller.googleapis.com/apps/reseller/v1/customers/C0123456/subscriptions/123/changeSeats

L'abbonamento di un piano con impegno annuale di Google Workspace utilizza questo corpo della richiesta per aggiornare il numero di licenze utente. Il valore numberOfSeats è un totali. Ad esempio, se in precedenza avevi 10 licenze utente e disponi di dall'ordine del cliente cinque nuove licenze, il totale nel corpo della richiesta per numberOfSeats è 15, come mostrato nell'esempio seguente:

{
    "kind": "subscriptions#seats",
    "numberOfSeats": 15
}

Aggiornare le utenze per l'abbonamento a un piano flessibile

L'abbonamento di un piano flessibile di Google Workspace utilizza il corpo della richiesta per aggiornare le licenze utente. Il valore maximumNumberOfSeats corrisponde al totale di licenze esistenti e quelle nuove. Questo è il numero massimo di utenti licenze di cui l'account può eseguire.

{
  "kind": "subscriptions#seats",
  "maximumNumberOfSeats": 15
}

Una risposta corretta restituisce un codice di stato HTTP 201 e impostazioni delle licenze di abbonamento:

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "skuId": "1010020028",
  "creationTime": "1331647980142",
  "plan": {
    "planName": "FLEXIBLE",
    "isCommitmentPlan": false
  },
  "seats": {
    "kind": "subscriptions#seats",
    "maximumNumberOfSeats": 15,
    "licensedNumberOfSeats": 10
  },
  "trialSettings": {
    "isInTrial": false
  },
  "skuName": "Google Workspace Business Standard"
}

Aggiornare le impostazioni di rinnovo di un abbonamento

Per aggiornare le impostazioni di rinnovo di un abbonamento con impegno annuale, utilizza la seguente richiesta HTTP POST:

POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID/changeRenewalSettings

Sostituisci quanto segue:

Di seguito è riportato un esempio di corpo della richiesta:

{
  "kind": "subscriptions#renewalSettings",
  "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
}

Il valore della proprietà renewalType può essere uno dei seguenti:

  • AUTO_RENEW_YEARLY_PAY: al termine dell'intervallo di un piano con impegno annuale, rinnova automaticamente il piano dell'abbonamento come ANNUAL_YEARLY_PAY con il stesso numberOfSeats.
  • AUTO_RENEW_MONTHLY_PAY: alla fine di un piano con impegno annuale a intervalli regolari, rinnova automaticamente il piano degli abbonamenti ANNUAL_MONTHLY_PAY con lo stesso numberOfSeats.
  • RENEW_CURRENT_USERS_YEARLY_PAY: alla fine di un piano con impegno annuale l'intervallo, rinnova il piano dell'abbonamento come ANNUAL_YEARLY_PAY ma utilizza numero totale di licenze utente attive attuali. Questa è l'impostazione predefinita per i piani di impegno annuale attivi (pagamento annuale).
  • RENEW_CURRENT_USERS_MONTHLY_PAY: alla fine di un piano con impegno annuale l'intervallo, rinnova il piano dell'abbonamento come ANNUAL_MONTHLY_PAY ma utilizza numero totale di licenze utente attive attuali. Questa è l'impostazione predefinita per i piani di impegno annuale attivi (pagamento mensile).
  • RENEW_ON_PROPOSED_OFFER: alla fine del piano con impegno attuale intervallo, rinnova in base all'ultima proposta di rinnovo con numberOfSeats come numero di licenze utente attive attuali o di impegno di offerta proposto, a seconda di quale sia in alto.
  • SWITCH_TO_PAY_AS_YOU_GO: alla fine di un piano con impegno annuale l'intervallo, cambiare il piano con impegno annuale in un piano flessibile.
  • CANCEL: al termine di un intervallo del piano di impegno annuale, l'abbonamento è stato sospeso. Per informazioni su come revocare una sospensione, consulta le Centro assistenza per gli amministratori.
di Gemini Advanced.

Una risposta corretta restituisce un codice di stato HTTP 201 e impostazioni di rinnovo dell'abbonamento:

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "skuId": "1010020028",
  "creationTime": "1331647980142",
  "plan": {
    "planName": "ANNUAL",
    "isCommitmentPlan": true,
    "commitmentInterval": {
      "startTime": "1331647980142",
      "endTime": "1363183980142"
    }
  },
  "seats": {
    "kind": "subscriptions#seats",
    "numberOfSeats": 15,
    "licensedNumberOfSeats": 15
  },
  "trialSettings": {
    "isInTrial": false
  },
  "renewalSettings": {
    "kind": "subscriptions#renewalSettings",
    "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
  },
  "skuName": "Google Workspace Business Standard"
}

Iniziare il servizio a pagamento da un abbonamento di prova senza costi

Passare immediatamente un abbonamento di prova senza costi di 30 giorni a un servizio a pagamento. abbonamento, se è già stato configurato un piano di pagamento per la prova usa la seguente richiesta HTTP POST. 

POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID/startPaidService

Sostituisci quanto segue:

L'esempio seguente ha C0123456 come customerId e Valore subscriptionId di 123:

POST https://reseller.googleapis.com/apps/reseller/v1/customers/C0123456/subscriptions/123/startPaidService

Questa operazione non ha parametri nel corpo della richiesta.

Una risposta corretta restituisce un codice di stato HTTP 201 e le impostazioni di abbonamento aggiornate:

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "skuId": "1010020028",
  "creationTime": "1331647980142",
  "plan": {
    "planName": "ANNUAL",
    "isCommitmentPlan": true,
    "commitmentInterval": {
      "startTime": "1331647980142",
      "endTime": "1363183980142"
    }
  },
  "seats": {
    "kind": "subscriptions#seats",
    "numberOfSeats": 15,
    "licensedNumberOfSeats": 15
  },
  "trialSettings": {
    "isInTrial": false
  },
  "renewalSettings": {
    "kind": "subscriptions#renewalSettings",
    "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
  },
  "skuName": "Google Workspace Business Standard"
}

Eseguire l'upgrade o il downgrade di un abbonamento

Non puoi eseguire il downgrade dei piani annuali durante il loro periodo di validità e pianificare un downgrade utilizzando le impostazioni di rinnovo. Ti consigliamo di impostare impostazioni di rinnovo per passare a FLEXIBLE ed eseguire il downgrade alla scadenza del rinnovo.

Per eseguire l'upgrade o il downgrade di un abbonamento, crea un nuovo abbonamento con il skuId di cui vuoi eseguire l'upgrade o il downgrade.

POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions

Sostituisci quanto segue:

  • CUSTOMER_ID: il dominio principale del cliente nome utente o l'identificatore univoco del cliente.

Questa chiamata termina l'abbonamento precedente e ne crea uno nuovo.

Ulteriori informazioni su di upgrade e downgrade sui Prodotti e SKU.