Method: monetization.subscriptions.basePlans.offers.batchGet

  • The offers.batchGet endpoint reads one or more subscription offers using a POST request.

  • The request requires path parameters for packageName, productId, and basePlanId, which can sometimes use a "-" placeholder to indicate multiple resources.

  • The request body includes a list of GetSubscriptionOfferRequest objects specifying the offers to retrieve.

  • The response body contains a list of SubscriptionOffer objects representing the retrieved offers.

  • Authorization using the https://www.googleapis.com/auth/androidpublisher OAuth scope is required.

Reads one or more subscription offers.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
packageName

string

Required. The parent app (package name) for which the subscriptions should be created or updated. Must be equal to the packageName field on all the requests.
productId

string

Required. The product ID of the parent subscription, if all updated offers belong to the same subscription. If this request spans multiple subscriptions, set this field to "-". Must be set.
basePlanId

string

Required. The parent base plan (ID) for which the offers should be read. May be specified as '-' to read offers from multiple base plans.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "requests": [
    {
      object (GetSubscriptionOfferRequest)
    }
  ]
}
Fields
requests[]

object (GetSubscriptionOfferRequest)

Required. A list of update requests of up to 100 elements. All requests must update different subscriptions.

Response body

Response message for offers.batchGet endpoint.

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

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

object (SubscriptionOffer)

Authorization scopes

Requires the following OAuth scope:

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

GetSubscriptionOfferRequest

Request message for offers.get.

JSON representation 
{
  "packageName": string,
  "productId": string,
  "basePlanId": string,
  "offerId": string
}
Fields
packageName

string

Required. The parent app (package name) of the offer to get.
productId

string

Required. The parent subscription (ID) of the offer to get.
basePlanId

string

Required. The parent base plan (ID) of the offer to get.
offerId

string

Required. The unique offer ID of the offer to get.