google_api_reseller

v0.7.0

google_api_reseller v0.7.0 GoogleApi.Reseller.V1.Api.Subscriptions View Source

API calls for all endpoints tagged Subscriptions.

Link to this section Summary

Functions

reseller_subscriptions_activate(connection, customer_id, subscription_id, optional_params \\ [], opts \\ [])

Activates a subscription previously suspended by the reseller

reseller_subscriptions_change_plan(connection, customer_id, subscription_id, optional_params \\ [], opts \\ [])

Update a subscription plan. Use this method to update a plan for a 30-day trial or a flexible plan subscription to an annual commitment plan with monthly or yearly payments.

reseller_subscriptions_change_renewal_settings(connection, customer_id, subscription_id, optional_params \\ [], opts \\ [])

Update a user license's renewal settings. This is applicable for accounts with annual commitment plans only.

reseller_subscriptions_change_seats(connection, customer_id, subscription_id, optional_params \\ [], opts \\ [])

Update a subscription's user license settings.

reseller_subscriptions_delete(connection, customer_id, subscription_id, deletion_type, optional_params \\ [], opts \\ [])

Cancel, suspend, or transfer a subscription to direct.

reseller_subscriptions_get(connection, customer_id, subscription_id, optional_params \\ [], opts \\ [])

Get a specific subscription.

reseller_subscriptions_insert(connection, customer_id, optional_params \\ [], opts \\ [])

Create or transfer a subscription.

reseller_subscriptions_list(connection, optional_params \\ [], opts \\ [])

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.

reseller_subscriptions_start_paid_service(connection, customer_id, subscription_id, optional_params \\ [], opts \\ [])

Immediately move a 30-day free trial subscription to a paid service subscription.

reseller_subscriptions_suspend(connection, customer_id, subscription_id, optional_params \\ [], opts \\ [])

Suspends an active subscription.

Link to this section Functions

Link to this function

reseller_subscriptions_activate(connection, customer_id, subscription_id, optional_params \\ [], opts \\ [])

View Source 
reseller_subscriptions_activate(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Reseller.V1.Model.Subscription.t()} | {:error, Tesla.Env.t()}

Activates a subscription previously suspended by the reseller

Parameters

  • connection (type: GoogleApi.Reseller.V1.Connection.t) - Connection to server
  • customer_id (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 a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.
  • subscription_id (type: String.t) - This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method.

  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Reseller.V1.Model.Subscription{}} on success
  • {:error, info} on failure
Link to this function

reseller_subscriptions_change_plan(connection, customer_id, subscription_id, optional_params \\ [], opts \\ [])

View Source 
reseller_subscriptions_change_plan(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Reseller.V1.Model.Subscription.t()} | {:error, Tesla.Env.t()}

Update a subscription plan. Use this method to update a plan for a 30-day trial or a flexible plan subscription to an annual commitment plan with monthly or yearly payments.

Parameters

  • connection (type: GoogleApi.Reseller.V1.Connection.t) - Connection to server
  • customer_id (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 a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.
  • subscription_id (type: String.t) - This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method.

  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :body (type: GoogleApi.Reseller.V1.Model.ChangePlanRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Reseller.V1.Model.Subscription{}} on success
  • {:error, info} on failure
Link to this function

reseller_subscriptions_change_renewal_settings(connection, customer_id, subscription_id, optional_params \\ [], opts \\ [])

View Source 
reseller_subscriptions_change_renewal_settings(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Reseller.V1.Model.Subscription.t()} | {:error, Tesla.Env.t()}

Update a user license's renewal settings. This is applicable for accounts with annual commitment plans only.

Parameters

  • connection (type: GoogleApi.Reseller.V1.Connection.t) - Connection to server
  • customer_id (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 a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.
  • subscription_id (type: String.t) - This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method.

  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :body (type: GoogleApi.Reseller.V1.Model.RenewalSettings.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Reseller.V1.Model.Subscription{}} on success
  • {:error, info} on failure
Link to this function

reseller_subscriptions_change_seats(connection, customer_id, subscription_id, optional_params \\ [], opts \\ [])

View Source 
reseller_subscriptions_change_seats(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Reseller.V1.Model.Subscription.t()} | {:error, Tesla.Env.t()}

Update a subscription's user license settings.

Parameters

  • connection (type: GoogleApi.Reseller.V1.Connection.t) - Connection to server
  • customer_id (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 a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.
  • subscription_id (type: String.t) - This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method.

  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :body (type: GoogleApi.Reseller.V1.Model.Seats.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Reseller.V1.Model.Subscription{}} on success
  • {:error, info} on failure
Link to this function

reseller_subscriptions_delete(connection, customer_id, subscription_id, deletion_type, optional_params \\ [], opts \\ [])

View Source 
reseller_subscriptions_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Cancel, suspend, or transfer a subscription to direct.

Parameters

  • connection (type: GoogleApi.Reseller.V1.Connection.t) - Connection to server
  • customer_id (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 a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.
  • subscription_id (type: String.t) - This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method.
  • deletion_type (type: String.t) - The deletionType query string enables the cancellation, downgrade, or suspension of a subscription.

  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %{}} on success
  • {:error, info} on failure
Link to this function

reseller_subscriptions_get(connection, customer_id, subscription_id, optional_params \\ [], opts \\ [])

View Source 
reseller_subscriptions_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Reseller.V1.Model.Subscription.t()} | {:error, Tesla.Env.t()}

Get a specific subscription.

Parameters

  • connection (type: GoogleApi.Reseller.V1.Connection.t) - Connection to server
  • customer_id (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 a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.
  • subscription_id (type: String.t) - This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method.

  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Reseller.V1.Model.Subscription{}} on success
  • {:error, info} on failure
Link to this function

reseller_subscriptions_insert(connection, customer_id, optional_params \\ [], opts \\ [])

View Source 
reseller_subscriptions_insert(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Reseller.V1.Model.Subscription.t()} | {:error, Tesla.Env.t()}

Create or transfer a subscription.

Parameters

  • connection (type: GoogleApi.Reseller.V1.Connection.t) - Connection to server
  • customer_id (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 a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.

  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :customerAuthToken (type: String.t) - 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.
    • :body (type: GoogleApi.Reseller.V1.Model.Subscription.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Reseller.V1.Model.Subscription{}} on success
  • {:error, info} on failure
Link to this function

reseller_subscriptions_list(connection, optional_params \\ [], opts \\ [])

View Source 
reseller_subscriptions_list(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Reseller.V1.Model.Subscriptions.t()} | {:error, Tesla.Env.t()}

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.

Parameters

  • connection (type: GoogleApi.Reseller.V1.Connection.t) - Connection to server

  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :customerAuthToken (type: String.t) - 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 (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 a customerId as a key for persistent data. If the domain name for a customerId 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 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 (type: 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.
    • :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
Link to this function

reseller_subscriptions_start_paid_service(connection, customer_id, subscription_id, optional_params \\ [], opts \\ [])

View Source 
reseller_subscriptions_start_paid_service(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Reseller.V1.Model.Subscription.t()} | {:error, Tesla.Env.t()}

Immediately move a 30-day free trial subscription to a paid service subscription.

Parameters

  • connection (type: GoogleApi.Reseller.V1.Connection.t) - Connection to server
  • customer_id (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 a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.
  • subscription_id (type: String.t) - This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method.

  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Reseller.V1.Model.Subscription{}} on success
  • {:error, info} on failure
Link to this function

reseller_subscriptions_suspend(connection, customer_id, subscription_id, optional_params \\ [], opts \\ [])

View Source 
reseller_subscriptions_suspend(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Reseller.V1.Model.Subscription.t()} | {:error, Tesla.Env.t()}

Suspends an active subscription.

Parameters

  • connection (type: GoogleApi.Reseller.V1.Connection.t) - Connection to server
  • customer_id (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 a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.
  • subscription_id (type: String.t) - This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method.

  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Reseller.V1.Model.Subscription{}} on success
  • {:error, info} on failure