Class SubscriptionsResource.ListRequest

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.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<Subscriptions>
ResellerBaseServiceRequest<Subscriptions>
SubscriptionsResource.ListRequest
Implements
Inherited Members
Namespace: Google.Apis.Reseller.v1
Assembly: Google.Apis.Reseller.v1.dll
Syntax
public class SubscriptionsResource.ListRequest : ResellerBaseServiceRequest<Subscriptions>, IClientServiceRequest<Subscriptions>, IClientServiceRequest

Constructors

ListRequest(IClientService)

Constructs a new List request.

Declaration
public ListRequest(IClientService service)
Parameters
Type Name Description
IClientService service

Properties

CustomerAuthToken

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.

Declaration
[RequestParameter("customerAuthToken", RequestParameterType.Query)]
public virtual string CustomerAuthToken { get; set; }
Property Value
Type Description
string

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.

Declaration
[RequestParameter("customerId", RequestParameterType.Query)]
public virtual string CustomerId { get; set; }
Property Value
Type Description
string

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 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.

Declaration
[RequestParameter("customerNamePrefix", RequestParameterType.Query)]
public virtual string CustomerNamePrefix { get; set; }
Property Value
Type Description
string

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

MaxResults

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.

Declaration
[RequestParameter("maxResults", RequestParameterType.Query)]
public virtual long? MaxResults { get; set; }
Property Value
Type Description
long?

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

PageToken

Token to specify next page in the list

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements