Subscriptions: list

Requires authorization

List 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. Try it now.

Optionally, this method can filter the response by a customerNamePrefix. For more information, see manage subscriptions.

Request

HTTP request

GET https://www.googleapis.com/apps/reseller/v1/subscriptions

Parameters

Parameter name	Value	Description
Optional query 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`	`unsigned integer`	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. Acceptable values are `1` to `100`, inclusive.
`pageToken`	`string`	Token to specify next page in the list

Authorization

This request requires authorization with at least one of the following scopes (read more about authentication and authorization).

Scope
`https://www.googleapis.com/auth/apps.order`
`https://www.googleapis.com/auth/apps.order.readonly`

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure:

{
  "kind": "reseller#subscriptions",
  "subscriptions": [
    subscriptions Resource
  ],
  "nextPageToken": string
}

Property name	Value	Description
`kind`	`string`	Identifies the resource as a collection of subscriptions. Value: reseller#subscriptions
`subscriptions[]`	`list`	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.

Try it!

Use the APIs Explorer below to call this method on live data and see the response. Alternatively, try the standalone Explorer.