GoogleApi.Reseller.V1.Api.Subscriptions.reseller_subscriptions_list
You're seeing just the function
reseller_subscriptions_list
, go back to GoogleApi.Reseller.V1.Api.Subscriptions module for more information.
Link to this function
reseller_subscriptions_list(connection, optional_params \\ [], opts \\ [])
View SourceSpecs
reseller_subscriptions_list(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.Reseller.V1.Model.Subscriptions.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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. Optionally, this method can filter the response by a customerNamePrefix
. For more information, see manage subscriptions.
Parameters
-
connection
(type:GoogleApi.Reseller.V1.Connection.t
) - Connection to server -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:customerAuthToken
(type:String.t
) - ThecustomerAuthToken
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
(type:String.t
) - Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using acustomerId
as a key for persistent data. If the domain name for acustomerId
is changed, the Google system automatically updates. -
:customerNamePrefix
(type:String.t
) - 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 includesexam.com
,example20.com
andexample.com
: -exa
-- Returns all customer names that start with 'exa' which could includeexam.com
,example20.com
, andexample.com
. A name prefix is similar to using a regular expression's asterisk, exa*. -example
-- Returnsexample20.com
andexample.com
. -
:maxResults
(type:integer()
) - When retrieving a large list, themaxResults
is the maximum number of results per page. ThenextPageToken
value takes you to the next page. The default is 20. -
:pageToken
(type:String.t
) - Token to specify next page in the list
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Reseller.V1.Model.Subscriptions{}}
on success -
{:error, info}
on failure