Method: monetization.subscriptions.basePlans.offers.list

  • The offers.list method lists all offers under a given subscription using an HTTP GET request.

  • The request requires path parameters for the package name, product ID, and base plan ID to identify the specific subscription.

  • Optional query parameters pageSize and pageToken can be used for pagination of the results.

  • The request body must be empty, and the response body contains a list of SubscriptionOffer objects and an optional nextPageToken for subsequent pages.

  • Authorization requires the https://www.googleapis.com/auth/androidpublisher OAuth scope.

Lists all offers under a given subscription.

HTTP request

GET https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
packageName

string

Required. The parent app (package name) for which the subscriptions should be read.
productId

string

Required. The parent subscription (ID) for which the offers should be read. May be specified as '-' to read all offers under an app.
basePlanId

string

Required. The parent base plan (ID) for which the offers should be read. May be specified as '-' to read all offers under a subscription or an app. Must be specified as '-' if productId is specified as '-'.

Query parameters

Parameters
pageSize

integer

The maximum number of subscriptions to return. The service may return fewer than this value. If unspecified, at most 50 subscriptions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken

string

A page token, received from a previous ListSubscriptionsOffers call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to offers.list must match the call that provided the page token.

Request body

The request body must be empty.

Response body

Response message for offers.list.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "subscriptionOffers": [
    {
      object (SubscriptionOffer)
    }
  ],
  "nextPageToken": string
}
Fields
subscriptionOffers[]

object (SubscriptionOffer)

The subscription offers from the specified subscription.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/androidpublisher