GoogleApi.AndroidPublisher.V3.Api.Purchases.androidpublisher_purchases_subscriptions_cancel

You're seeing just the function androidpublisher_purchases_subscriptions_cancel, go back to GoogleApi.AndroidPublisher.V3.Api.Purchases module for more information.
Link to this function

androidpublisher_purchases_subscriptions_cancel(connection, package_name, subscription_id, token, optional_params \\ [], opts \\ [])

View Source

Specs

androidpublisher_purchases_subscriptions_cancel(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Cancels a user's subscription purchase. The subscription remains valid until its expiration time.

Parameters

  • connection (type: GoogleApi.AndroidPublisher.V3.Connection.t) - Connection to server
  • package_name (type: String.t) - The package name of the application for which this subscription was purchased (for example, 'com.some.thing').
  • subscription_id (type: String.t) - The purchased subscription ID (for example, 'monthly001').
  • token (type: String.t) - The token provided to the user's device when the subscription was purchased.
  • 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, %{}} on success
  • {:error, info} on failure