Method: subscriptions.list
Mantieni tutto organizzato con le raccolte
Salva e classifica i contenuti in base alle tue preferenze.
Elenchi di abbonamenti gestiti dal rivenditore. L'elenco può essere costituito da tutti gli abbonamenti, da tutti gli abbonamenti di un cliente o da tutti gli abbonamenti trasferibili di un cliente.
Se vuoi, questo metodo può filtrare la risposta in base a un customerNamePrefix
. Per saperne di più, consulta la sezione Gestire gli abbonamenti.
Richiesta HTTP
GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions
L'URL utilizza la sintassi di transcodifica gRPC.
Parametri di query
Parametri |
customerAuthToken |
string
La stringa di query customerAuthToken è obbligatoria quando crei un account rivenduto che trasferisce l'abbonamento di un cliente diretto o l'abbonamento di un altro cliente del rivenditore alla tua gestione del rivenditore. Si tratta di un token di autenticazione esadecimale necessario per completare il trasferimento dell'abbonamento. Per ulteriori informazioni, visita il Centro assistenza per gli amministratori.
|
customerId |
string
Può essere il nome di dominio principale del cliente o il suo identificatore univoco. Se il nome di dominio di un cliente cambia, il vecchio nome di dominio non può essere utilizzato per accedere al cliente, ma è sempre possibile utilizzare l'identificatore univoco del cliente (come restituito dall'API). Ti consigliamo di memorizzare l'identificatore univoco nei tuoi sistemi, se applicabile.
|
customerNamePrefix |
string
Quando recuperi tutti i tuoi abbonamenti e filtri in base a clienti specifici, puoi inserire un prefisso per il nome di un cliente. Utilizzando un gruppo di clienti di esempio che include exam.com , example20.com e example.com : exa : restituisce tutti i nomi dei clienti che iniziano con "exa", ad esempio exam.com , example20.com e example.com . Un prefisso del nome è simile all'utilizzo dell'asterisco di un'espressione regolare, exa*. example : restituisce example20.com e example.com .
|
maxResults |
integer (uint32 format)
Quando viene recuperato un elenco di grandi dimensioni, maxResults è il numero massimo di risultati per pagina. Il valore nextPageToken ti reindirizza alla pagina successiva. Il valore predefinito è 20.
|
pageToken |
string
Token per specificare la pagina successiva nell'elenco
|
Corpo della richiesta
Il corpo della richiesta deve essere vuoto.
Corpo della risposta
Un abbonamento gestisce la relazione del piano di pagamento di un cliente Google con lo SKU, le licenze utente, lo stato della prova senza costi di 30 giorni e le opzioni di rinnovo di un prodotto. Il ruolo principale di un rivenditore è gestire gli abbonamenti del cliente Google.
In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:
Rappresentazione JSON |
{
"kind": string,
"subscriptions": [
{
object (Subscription )
}
],
"nextPageToken": string
} |
Campi |
kind |
string
Identifica la risorsa come una raccolta di abbonamenti. Valore: reseller#subscriptions
|
subscriptions[] |
object (Subscription )
Gli abbonamenti in questa pagina di risultati.
|
nextPageToken |
string
Il token di continuazione, utilizzato per sfogliare set di risultati di grandi dimensioni. Fornisci questo valore in una richiesta successiva per restituire la pagina di risultati successiva.
|
Ambiti di autorizzazione
Richiede uno dei seguenti ambiti OAuth:
https://www.googleapis.com/auth/apps.order
https://www.googleapis.com/auth/apps.order.readonly
Per ulteriori informazioni, consulta la Guida all'autorizzazione.
Salvo quando diversamente specificato, i contenuti di questa pagina sono concessi in base alla licenza Creative Commons Attribution 4.0, mentre gli esempi di codice sono concessi in base alla licenza Apache 2.0. Per ulteriori dettagli, consulta le norme del sito di Google Developers. Java è un marchio registrato di Oracle e/o delle sue consociate.
Ultimo aggiornamento 2025-07-25 UTC.
[null,null,["Ultimo aggiornamento 2025-07-25 UTC."],[],[],null,["# Method: subscriptions.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.Subscriptions.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists of subscriptions managed by the reseller. The list can be all subscriptions, all of a customer's subscriptions, or all of a customer's transferable subscriptions.\n\nOptionally, this method can filter the response by a `customerNamePrefix`. For more information, see [manage subscriptions](https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_subscriptions).\n\n### HTTP request\n\n`GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `customerAuthToken` | `string` The `customerAuthToken` query string is required when creating a resold account that transfers a direct customer's subscription or transfers another reseller customer's subscription to your reseller management. This is a hexadecimal authentication token needed to complete the subscription transfer. For more information, see the [administrator help center](//support.google.com/a/bin/answer.py?answer=142336). |\n| `customerId` | `string` This can be either the customer's primary domain name or the customer's unique identifier. If the domain name for a customer changes, the old domain name cannot be used to access the customer, but the customer's unique identifier (as returned by the API) can always be used. We recommend storing the unique identifier in your systems where applicable. |\n| `customerNamePrefix` | `string` When retrieving all of your subscriptions and filtering for specific customers, you can enter a prefix for a customer name. Using an example customer group that includes `exam.com`, `example20.com` and `example.com`: - `exa` -- Returns all customer names that start with 'exa' which could include `exam.com`, `example20.com`, and `example.com`. A name prefix is similar to using a regular expression's asterisk, exa\\*. - `example` -- Returns `example20.com` and `example.com`. \u003cbr /\u003e |\n| `maxResults` | `integer (`[uint32](https://developers.google.com/discovery/v1/type-format)` format)` When retrieving a large list, the `maxResults` is the maximum number of results per page. The `nextPageToken` value takes you to the next page. The default is 20. |\n| `pageToken` | `string` Token to specify next page in the list |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nA subscription manages the relationship of a Google customer's payment plan with a product's SKU, user licenses, 30-day free trial status, and renewal options. A primary role of a reseller is to manage the Google customer's subscriptions.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"subscriptions\": [ { object (/workspace/admin/reseller/reference/rest/v1/subscriptions#Subscription) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies the resource as a collection of subscriptions. Value: reseller#subscriptions |\n| `subscriptions[]` | `object (`[Subscription](/workspace/admin/reseller/reference/rest/v1/subscriptions#Subscription)`)` The subscriptions in this page of results. |\n| `nextPageToken` | `string` The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/apps.order`\n- `\n https://www.googleapis.com/auth/apps.order.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]