Method: subscriptions.list
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Son listas de suscripciones administradas por el revendedor. La lista puede incluir todas las suscripciones, todas las suscripciones de un cliente o todas las suscripciones transferibles de un cliente.
De manera opcional, este método puede filtrar la respuesta por un customerNamePrefix
. Para obtener más información, consulta Administrar suscripciones.
Solicitud HTTP
GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de consulta
Parámetros |
customerAuthToken |
string
La cadena de consulta customerAuthToken es obligatoria cuando se crea una cuenta revendida que transfiere la suscripción de un cliente directo o la suscripción de otro cliente revendedor a tu administración de revendedores. Este es un token de autenticación hexadecimal necesario para completar la transferencia de la suscripción. Para obtener más información, consulta el Centro de ayuda para administradores.
|
customerId |
string
Puede ser el nombre de dominio principal del cliente o su identificador único. Si cambia el nombre de dominio de un cliente, no se puede usar el nombre de dominio anterior para acceder a él, pero siempre se puede usar el identificador único del cliente (como lo muestra la API). Te recomendamos que almacenes el identificador único en tus sistemas cuando corresponda.
|
customerNamePrefix |
string
Cuando recuperes todas tus suscripciones y filtres por clientes específicos, puedes ingresar un prefijo para el nombre de un cliente. Con un ejemplo de grupo de clientes que incluye exam.com , example20.com y example.com : exa : Muestra todos los nombres de clientes que comienzan con "exa", lo que podría incluir exam.com , example20.com y example.com . Un prefijo de nombre es similar a usar el asterisco de una expresión regular, exa*. example : Muestra example20.com y example.com .
|
maxResults |
integer (uint32 format)
Cuando se recupera una lista grande, maxResults es la cantidad máxima de resultados por página. El valor nextPageToken te lleva a la página siguiente. El valor predeterminado es 20.
|
pageToken |
string
Token para especificar la página siguiente en la lista
|
Cuerpo de la solicitud
El cuerpo de la solicitud debe estar vacío.
Cuerpo de la respuesta
Una suscripción administra la relación del plan de pagos de un cliente de Google con el SKU de un producto, las licencias de usuario, el estado de la prueba gratuita de 30 días y las opciones de renovación. Una de las funciones principales de un revendedor es administrar las suscripciones de los clientes de Google.
Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:
Representación JSON |
{
"kind": string,
"subscriptions": [
{
object (Subscription )
}
],
"nextPageToken": string
} |
Campos |
kind |
string
Identifica el recurso como una colección de suscripciones. Valor: reseller#subscriptions
|
subscriptions[] |
object (Subscription )
Las suscripciones de esta página de resultados.
|
nextPageToken |
string
Es el token de continuación, que se usa para desplazarse por grandes conjuntos de resultados. Proporciona este valor en una solicitud posterior para mostrar la página siguiente de resultados.
|
Permisos de autorización
Se necesita uno de los siguientes permisos de OAuth:
https://www.googleapis.com/auth/apps.order
https://www.googleapis.com/auth/apps.order.readonly
Para obtener más información, consulta la Guía de autorización.
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-07-25 (UTC)
[null,null,["Última actualización: 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)."]]