REST Resource: monetization.subscriptions.basePlans.offers

{
  "packageName": string,
  "productId": string,
  "basePlanId": string,
  "offerId": string,
  "state": enum (State),
  "phases": [
    {
      object (SubscriptionOfferPhase)
    }
  ],
  "targeting": {
    object (SubscriptionOfferTargeting)
  },
  "regionalConfigs": [
    {
      object (RegionalSubscriptionOfferConfig)
    }
  ],
  "otherRegionsConfig": {
    object (OtherRegionsSubscriptionOfferConfig)
  },
  "offerTags": [
    {
      object (OfferTag)
    }
  ]
}

string

Required. Immutable. The package name of the app the parent subscription belongs to.

string

Required. Immutable. The ID of the parent subscription this offer belongs to.

string

Required. Immutable. The ID of the base plan to which this offer is an extension.

string

Required. Immutable. Unique ID of this subscription offer. Must be unique within the base plan.

enum (State)

Output only. The current state of this offer. Can be changed using Activate and Deactivate actions. NB: the base plan state supersedes this state, so an active offer may not be available if the base plan is not active.

object (SubscriptionOfferPhase)

Required. The phases of this subscription offer. Must contain at least one and at most two entries. Users will always receive all these phases in the specified order.

object (SubscriptionOfferTargeting)

The requirements that users need to fulfil to be eligible for this offer. Represents the requirements that Play will evaluate to decide whether an offer should be returned. Developers may further filter these offers themselves.

object (RegionalSubscriptionOfferConfig)

Required. The region-specific configuration of this offer. Must contain at least one entry.

object (OtherRegionsSubscriptionOfferConfig)

The configuration for any new locations Play may launch in the future.

object (OfferTag)

List of up to 20 custom tags specified for this offer, and returned to the app through the billing library.

{
  "recurrenceCount": integer,
  "duration": string,
  "regionalConfigs": [
    {
      object (RegionalSubscriptionOfferPhaseConfig)
    }
  ],
  "otherRegionsConfig": {
    object (OtherRegionsSubscriptionOfferPhaseConfig)
  }
}

integer

Required. The number of times this phase repeats. If this offer phase is not free, each recurrence charges the user the price of this offer phase.

string

Required. The duration of a single recurrence of this phase. Specified in ISO 8601 format.

object (RegionalSubscriptionOfferPhaseConfig)

Required. The region-specific configuration of this offer phase. This list must contain exactly one entry for each region for which the subscription offer has a regional config.

object (OtherRegionsSubscriptionOfferPhaseConfig)

Pricing information for any new locations Play may launch in.

{
  "regionCode": string,

  // Union field price_override can be only one of the following:
  "price": {
    object (Money)
  },
  "relativeDiscount": number,
  "absoluteDiscount": {
    object (Money)
  },
  "free": {
    object (RegionalSubscriptionOfferPhaseFreePriceOverride)
  }
  // End of list of possible types for union field price_override.
}

string

Required. Immutable. The region to which this config applies.

object (Money)

The absolute price the user pays for this offer phase. The price must not be smaller than the minimum price allowed for this region.

number

The fraction of the base plan price prorated over the phase duration that the user pays for this offer phase. For example, if the base plan price for this region is $12 for a period of 1 year, then a 50% discount for a phase of a duration of 3 months would correspond to a price of $1.50. The discount must be specified as a fraction strictly larger than 0 and strictly smaller than 1. The resulting price will be rounded to the nearest billable unit (e.g. cents for USD). The relative discount is considered invalid if the discounted price ends up being smaller than the minimum price allowed in this region.

object (Money)

The absolute amount of money subtracted from the base plan price prorated over the phase duration that the user pays for this offer phase. For example, if the base plan price for this region is $12 for a period of 1 year, then a $1 absolute discount for a phase of a duration of 3 months would correspond to a price of $2. The resulting price may not be smaller than the minimum price allowed for this region.

object (RegionalSubscriptionOfferPhaseFreePriceOverride)

Set to specify this offer is free to obtain.

{

  // Union field price_override can be only one of the following:
  "otherRegionsPrices": {
    object (OtherRegionsSubscriptionOfferPhasePrices)
  },
  "relativeDiscount": number,
  "absoluteDiscounts": {
    object (OtherRegionsSubscriptionOfferPhasePrices)
  },
  "free": {
    object (OtherRegionsSubscriptionOfferPhaseFreePriceOverride)
  }
  // End of list of possible types for union field price_override.
}

object (OtherRegionsSubscriptionOfferPhasePrices)

The absolute price the user pays for this offer phase. The price must not be smaller than the minimum price allowed for any new locations Play may launch in.

number

The fraction of the base plan price prorated over the phase duration that the user pays for this offer phase. For example, if the base plan price for this region is $12 for a period of 1 year, then a 50% discount for a phase of a duration of 3 months would correspond to a price of $1.50. The discount must be specified as a fraction strictly larger than 0 and strictly smaller than 1. The resulting price will be rounded to the nearest billable unit (e.g. cents for USD). The relative discount is considered invalid if the discounted price ends up being smaller than the minimum price allowed in any new locations Play may launch in.

object (OtherRegionsSubscriptionOfferPhasePrices)

The absolute amount of money subtracted from the base plan price prorated over the phase duration that the user pays for this offer phase. For example, if the base plan price for this region is $12 for a period of 1 year, then a $1 absolute discount for a phase of a duration of 3 months would correspond to a price of $2. The resulting price may not be smaller than the minimum price allowed for any new locations Play may launch in.

object (OtherRegionsSubscriptionOfferPhaseFreePriceOverride)

Set to specify this offer is free to obtain.

{
  "usdPrice": {
    object (Money)
  },
  "eurPrice": {
    object (Money)
  }
}

object (Money)

Required. Price in USD to use for any new locations Play may launch in.

object (Money)

Required. Price in EUR to use for any new locations Play may launch in.

{

  // Union field rule can be only one of the following:
  "acquisitionRule": {
    object (AcquisitionTargetingRule)
  },
  "upgradeRule": {
    object (UpgradeTargetingRule)
  }
  // End of list of possible types for union field rule.
}

object (AcquisitionTargetingRule)

Offer targeting rule for new user acquisition.

object (UpgradeTargetingRule)

Offer targeting rule for upgrading users' existing plans.

{
  "scope": {
    object (TargetingRuleScope)
  }
}

object (TargetingRuleScope)

Required. The scope of subscriptions this rule considers. Only allows "this subscription" and "any subscription in app".

{

  // Union field scope can be only one of the following:
  "thisSubscription": {
    object (TargetingRuleScopeThisSubscription)
  },
  "anySubscriptionInApp": {
    object (TargetingRuleScopeAnySubscriptionInApp)
  },
  "specificSubscriptionInApp": string
  // End of list of possible types for union field scope.
}

object (TargetingRuleScopeThisSubscription)

The scope of the current targeting rule is the subscription in which this offer is defined.

object (TargetingRuleScopeAnySubscriptionInApp)

The scope of the current targeting rule is any subscription in the parent app.

string

The scope of the current targeting rule is the subscription with the specified subscription ID. Must be a subscription within the same parent app.

{
  "oncePerUser": boolean,
  "scope": {
    object (TargetingRuleScope)
  },
  "billingPeriodDuration": string
}

boolean

Limit this offer to only once per user. If set to true, a user can never be eligible for this offer again if they ever subscribed to this offer.

object (TargetingRuleScope)

Required. The scope of subscriptions this rule considers. Only allows "this subscription" and "specific subscription in app".

string

The specific billing period duration, specified in ISO 8601 format, that a user must be currently subscribed to to be eligible for this rule. If not specified, users subscribed to any billing period are matched.

{
  "regionCode": string,
  "newSubscriberAvailability": boolean
}

string

Required. Immutable. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US".

boolean

Whether the subscription offer in the specified region is available for new subscribers. Existing subscribers will not have their subscription cancelled if this value is set to false. If not specified, this will default to false.

{
  "otherRegionsNewSubscriberAvailability": boolean
}

boolean

Whether the subscription offer in any new locations Play may launch in the future. If not specified, this will default to false.