View Source GoogleApi.AndroidPublisher.V3.Api.Orders (google_api_android_publisher v0.34.1)

API calls for all endpoints tagged Orders.

Summary

Functions

Refunds a user's subscription or in-app purchase order. Orders older than 3 years cannot be refunded.

Functions

Link to this function

androidpublisher_orders_refund(connection, package_name, order_id, optional_params \\ [], opts \\ [])

View Source
@spec androidpublisher_orders_refund(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Refunds a user's subscription or in-app purchase order. Orders older than 3 years cannot be refunded.

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 or in-app item was purchased (for example, 'com.some.thing').
  • order_id (type: String.t) - The order ID provided to the user when the subscription or in-app order 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").
    • :revoke (type: boolean()) - Whether to revoke the purchased item. If set to true, access to the subscription or in-app item will be terminated immediately. If the item is a recurring subscription, all future payments will also be terminated. Consumed in-app items need to be handled by developer's app. (optional).
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %{}} on success
  • {:error, info} on failure