Method: subscriptions.list

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

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.

customerId

string

Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.

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.

maxResults

integer (uint32 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.

pageToken

string

Token to specify next page in the list

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

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.

JSON representation
{
  "kind": string,
  "subscriptions": [
    {
      object (Subscription)
    }
  ],
  "nextPageToken": string
}
Fields
kind

string

Identifies the resource as a collection of subscriptions. Value: reseller#subscriptions

subscriptions[]

object (Subscription)

The subscriptions in this page of results.

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.

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 OAuth 2.0 Overview.