Lists 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.
Optionally, this method can filter the response by a customerNamePrefix
. For more information, see manage subscriptions.
HTTP request
GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions
The URL uses gRPC Transcoding syntax.
Query parameters
Parameters | |
---|---|
customerAuthToken |
The |
customerId |
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. |
customerNamePrefix |
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
|
maxResults |
When retrieving a large list, the |
pageToken |
Token to specify next page in the list |
Request body
The request body must be empty.
Response body
A 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.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"kind": string,
"subscriptions": [
{
object ( |
Fields | |
---|---|
kind |
Identifies the resource as a collection of subscriptions. Value: reseller#subscriptions |
subscriptions[] |
The subscriptions in this page of results. |
nextPageToken |
The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. |
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/apps.order
https://www.googleapis.com/auth/apps.order.readonly
For more information, see the Authorization guide.