REST Resource: monetization.subscriptions

{
  "packageName": string,
  "productId": string,
  "basePlans": [
    {
      object (BasePlan)
    }
  ],
  "listings": [
    {
      object (SubscriptionListing)
    }
  ],
  "archived": boolean,
  "taxAndComplianceSettings": {
    object (SubscriptionTaxAndComplianceSettings)
  },
  "restrictedPaymentCountries": {
    object (RestrictedPaymentCountries)
  }
}

string

Immutable. Package name of the parent app.

string

Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must be composed of lower-case letters (a-z), numbers (0-9), underscores (_) and dots (.). It must start with a lower-case letter or number, and be between 1 and 40 (inclusive) characters in length.

object (BasePlan)

The set of base plans for this subscription. Represents the prices and duration of the subscription if no other offers apply.

object (SubscriptionListing)

Required. List of localized listings for this subscription. Must contain at least an entry for the default language of the parent app.

boolean

Output only. Deprecated: subscription archiving is not supported.

object (SubscriptionTaxAndComplianceSettings)

Details about taxes and legal compliance.

object (RestrictedPaymentCountries)

Optional. Countries where the purchase of this subscription is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed.

{
  "basePlanId": string,
  "state": enum (State),
  "regionalConfigs": [
    {
      object (RegionalBasePlanConfig)
    }
  ],
  "offerTags": [
    {
      object (OfferTag)
    }
  ],
  "otherRegionsConfig": {
    object (OtherRegionsBasePlanConfig)
  },

  // Union field base_plan_type can be only one of the following:
  "autoRenewingBasePlanType": {
    object (AutoRenewingBasePlanType)
  },
  "prepaidBasePlanType": {
    object (PrepaidBasePlanType)
  },
  "installmentsBasePlanType": {
    object (InstallmentsBasePlanType)
  }
  // End of list of possible types for union field base_plan_type.
}

string

Required. Immutable. The unique identifier of this base plan. Must be unique within the subscription, and conform with RFC-1034. That is, this ID can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 63 characters.

enum (State)

Output only. The state of the base plan, i.e. whether it's active. Draft and inactive base plans can be activated or deleted. Active base plans can be made inactive. Inactive base plans can be canceled. This field cannot be changed by updating the resource. Use the dedicated endpoints instead.

object (RegionalBasePlanConfig)

Region-specific information for this base plan.

object (OfferTag)

List of up to 20 custom tags specified for this base plan, and returned to the app through the billing library. Subscription offers for this base plan will also receive these offer tags in the billing library.

object (OtherRegionsBasePlanConfig)

Pricing information for any new locations Play may launch in the future. If omitted, the BasePlan will not be automatically available any new locations Play may launch in the future.

object (AutoRenewingBasePlanType)

Set when the base plan automatically renews at a regular interval.

object (PrepaidBasePlanType)

Set when the base plan does not automatically renew at the end of the billing period.

object (InstallmentsBasePlanType)

Set for installments base plans where a user is committed to a specified number of payments.

{
  "billingPeriodDuration": string,
  "gracePeriodDuration": string,
  "accountHoldDuration": string,
  "resubscribeState": enum (ResubscribeState),
  "prorationMode": enum (SubscriptionProrationMode),
  "legacyCompatible": boolean,
  "legacyCompatibleSubscriptionOfferId": string
}

string

Required. Immutable. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center. The duration is immutable after the base plan is created.

string

Grace period of the subscription, specified in ISO 8601 format. Acceptable values are P0D (zero days), P3D (3 days), P7D (7 days), P14D (14 days), and P30D (30 days). If not specified, a default value will be used based on the recurring period duration.

string

Optional. Account hold period of the subscription, specified in ISO 8601 format. Acceptable values must be in DAYS and in the range P0D (zero days) to P30D (30 days). If not specified, the default value is P30D (30 days).

enum (ResubscribeState)

Whether users should be able to resubscribe to this base plan in Google Play surfaces. Defaults to RESUBSCRIBE_STATE_ACTIVE if not specified.

enum (SubscriptionProrationMode)

The proration mode for the base plan determines what happens when a user switches to this plan from another base plan. If unspecified, defaults to CHARGE_ON_NEXT_BILLING_DATE.

boolean

Whether the renewing base plan is backward compatible.

The backward compatible base plan is returned by the Google Play Billing Library deprecated method querySkuDetailsAsync().

Only one renewing base plan can be marked as legacy compatible for a given subscription.

string

Subscription offer id which is legacy compatible.

The backward compatible subscription offer is returned by the Google Play Billing Library deprecated method querySkuDetailsAsync().

Only one subscription offer can be marked as legacy compatible for a given renewing base plan.

To have no Subscription offer as legacy compatible set this field as empty string.

{
  "billingPeriodDuration": string,
  "timeExtension": enum (TimeExtension)
}

string

Required. Immutable. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center. The duration is immutable after the base plan is created.

enum (TimeExtension)

Whether users should be able to extend this prepaid base plan in Google Play surfaces. Defaults to TIME_EXTENSION_ACTIVE if not specified.

{
  "billingPeriodDuration": string,
  "committedPaymentsCount": integer,
  "renewalType": enum (RenewalType),
  "gracePeriodDuration": string,
  "accountHoldDuration": string,
  "resubscribeState": enum (ResubscribeState),
  "prorationMode": enum (SubscriptionProrationMode)
}

string

Required. Immutable. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center. The duration is immutable after the base plan is created.

integer

Required. Immutable. The number of payments the user is committed to. It is immutable after the base plan is created.

enum (RenewalType)

Required. Immutable. Installments base plan renewal type. Determines the behavior at the end of the initial commitment. The renewal type is immutable after the base plan is created.

string

Grace period of the subscription, specified in ISO 8601 format. Acceptable values are P0D (zero days), P3D (3 days), P7D (7 days), P14D (14 days), and P30D (30 days). If not specified, a default value will be used based on the recurring period duration.

string

Optional. Account hold period of the subscription, specified exclusively in days and in ISO 8601 format. Acceptable values are P0D (zero days) to P30D (30days). If not specified, the default value is P30D (30 days).

enum (ResubscribeState)

Whether users should be able to resubscribe to this base plan in Google Play surfaces. Defaults to RESUBSCRIBE_STATE_ACTIVE if not specified.

enum (SubscriptionProrationMode)

The proration mode for the base plan determines what happens when a user switches to this plan from another base plan. If unspecified, defaults to CHARGE_ON_NEXT_BILLING_DATE.

{
  "regionCode": string,
  "newSubscriberAvailability": boolean,
  "price": {
    object (Money)
  }
}

string

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

boolean

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

object (Money)

The price of the base plan in the specified region. Must be set if the base plan is available to new subscribers. Must be set in the currency that is linked to the specified region.

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

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.

boolean

Whether the base plan is available for new subscribers in any new locations Play may launch in. If not specified, this will default to false.

{
  "languageCode": string,
  "title": string,
  "benefits": [
    string
  ],
  "description": string
}

string

Required. The language of this listing, as defined by BCP-47, e.g. "en-US".

string

Required. The title of this subscription in the language of this listing. Plain text.

string

A list of benefits shown to the user on platforms such as the Play Store and in restoration flows in the language of this listing. Plain text. Ordered list of at most four benefits.

string

The description of this subscription in the language of this listing. Maximum length - 80 characters. Plain text.

{
  "regionCodes": [
    string
  ]
}

string

Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US".