GoogleApi.Reseller.V1.Api.Subscriptions.reseller_subscriptions_suspend
You're seeing just the function
reseller_subscriptions_suspend
, go back to GoogleApi.Reseller.V1.Api.Subscriptions module for more information.
Link to this function
reseller_subscriptions_suspend(connection, customer_id, subscription_id, optional_params \\ [], opts \\ [])
View SourceSpecs
reseller_subscriptions_suspend( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Reseller.V1.Model.Subscription.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Suspends an active subscription. You can use this method to suspend a paid subscription that is currently in the ACTIVE
state. For FLEXIBLE
subscriptions, billing is paused. For ANNUAL_MONTHLY_PAY
or ANNUAL_YEARLY_PAY
subscriptions: Suspending the subscription does not change the renewal date that was originally committed to. A suspended subscription does not renew. If you activate the subscription after the original renewal date, a new annual subscription will be created, starting on the day of activation. We strongly encourage you to suspend subscriptions only for short periods of time as suspensions over 60 days may result in the subscription being cancelled.
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 acustomerId
as a key for persistent data. If the domain name for acustomerId
is changed, the Google system automatically updates. -
subscription_id
(type:String.t
) - This is a required property. ThesubscriptionId
is the subscription identifier and is unique for each customer. Since asubscriptionId
changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And thesubscriptionId
can be found using the retrieve all reseller subscriptions method. -
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").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Reseller.V1.Model.Subscription{}}
on success -
{:error, info}
on failure