google_api_android_publisher v0.3.0 GoogleApi.AndroidPublisher.V2.Api.Purchases View Source

API calls for all endpoints tagged Purchases.

Link to this section Summary

Functions

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

Checks whether a user's subscription purchase is valid and returns its expiry time.

Refunds a user's subscription purchase, but the subscription remains valid until its expiration time and it will continue to recur.

Refunds and immediately revokes a user's subscription purchase. Access to the subscription will be terminated immediately and it will stop recurring.

Link to this section Functions

Link to this function

androidpublisher_purchases_products_get(connection, package_name, product_id, token, optional_params \\ [], opts \\ [])

View Source
androidpublisher_purchases_products_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AndroidPublisher.V2.Model.ProductPurchase.t()}
  | {:error, Tesla.Env.t()}

Checks the purchase and consumption status of an inapp item.

Parameters

  • connection (type: GoogleApi.AndroidPublisher.V2.Connection.t) - Connection to server
  • package_name (type: String.t) - The package name of the application the inapp product was sold in (for example, 'com.some.thing').
  • product_id (type: String.t) - The inapp product SKU (for example, 'com.some.thing.inapp1').
  • token (type: String.t) - The token provided to the user's device when the inapp product was purchased.
  • 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.AndroidPublisher.V2.Model.ProductPurchase{}} on success
  • {:error, info} on failure
Link to this function

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

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

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

Parameters

  • connection (type: GoogleApi.AndroidPublisher.V2.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

    • :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

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

View Source
androidpublisher_purchases_subscriptions_defer(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.AndroidPublisher.V2.Model.SubscriptionPurchasesDeferResponse.t()}
  | {:error, Tesla.Env.t()}

Defers a user's subscription purchase until a specified future expiration time.

Parameters

  • connection (type: GoogleApi.AndroidPublisher.V2.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

    • :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.AndroidPublisher.V2.Model.SubscriptionPurchasesDeferRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AndroidPublisher.V2.Model.SubscriptionPurchasesDeferResponse{}} on success
  • {:error, info} on failure
Link to this function

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

View Source
androidpublisher_purchases_subscriptions_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AndroidPublisher.V2.Model.SubscriptionPurchase.t()}
  | {:error, Tesla.Env.t()}

Checks whether a user's subscription purchase is valid and returns its expiry time.

Parameters

  • connection (type: GoogleApi.AndroidPublisher.V2.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

    • :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.AndroidPublisher.V2.Model.SubscriptionPurchase{}} on success
  • {:error, info} on failure
Link to this function

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

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

Refunds a user's subscription purchase, but the subscription remains valid until its expiration time and it will continue to recur.

Parameters

  • connection (type: GoogleApi.AndroidPublisher.V2.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

    • :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

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

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

Refunds and immediately revokes a user's subscription purchase. Access to the subscription will be terminated immediately and it will stop recurring.

Parameters

  • connection (type: GoogleApi.AndroidPublisher.V2.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

    • :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

androidpublisher_purchases_voidedpurchases_list(connection, package_name, optional_params \\ [], opts \\ [])

View Source
androidpublisher_purchases_voidedpurchases_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AndroidPublisher.V2.Model.VoidedPurchasesListResponse.t()}
  | {:error, Tesla.Env.t()}

Lists the purchases that were canceled, refunded or charged-back.

Parameters

  • connection (type: GoogleApi.AndroidPublisher.V2.Connection.t) - Connection to server
  • package_name (type: String.t) - The package name of the application for which voided purchases need to be returned (for example, 'com.some.thing').
  • 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.
    • :endTime (type: String.t) - The time, in milliseconds since the Epoch, of the newest voided in-app product purchase that you want to see in the response. The value of this parameter cannot be greater than the current time and is ignored if a pagination token is set. Default value is current time. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response.
    • :maxResults (type: integer()) -
    • :startIndex (type: integer()) -
    • :startTime (type: String.t) - The time, in milliseconds since the Epoch, of the oldest voided in-app product purchase that you want to see in the response. The value of this parameter cannot be older than 30 days and is ignored if a pagination token is set. Default value is current time minus 30 days. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response.
    • :token (type: String.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AndroidPublisher.V2.Model.VoidedPurchasesListResponse{}} on success
  • {:error, info} on failure