REST Resource: monetization.subscriptions

Ресурс: Подписка

Единая подписка на приложение.

JSON-представление
{
  "packageName": string,
  "productId": string,
  "basePlans": [
    {
      object (BasePlan)
    }
  ],
  "listings": [
    {
      object (SubscriptionListing)
    }
  ],
  "archived": boolean,
  "taxAndComplianceSettings": {
    object (SubscriptionTaxAndComplianceSettings)
  },
  "restrictedPaymentCountries": {
    object (RestrictedPaymentCountries)
  }
}
Поля
packageName

string

Неизменяемый. Имя пакета родительского приложения.

productId

string

Неизменяемый. Уникальный идентификатор продукта. Уникален в пределах родительского приложения. Идентификаторы продуктов должны состоять из строчных букв (az), цифр (0-9), подчеркиваний (_) и точек (.). Он должен начинаться со строчной буквы или цифры и иметь длину от 1 до 40 (включительно) символов.

basePlans[]

object ( BasePlan )

Набор базовых планов для этой подписки. Представляет цены и продолжительность подписки, если другие предложения не применяются.

listings[]

object ( SubscriptionListing )

Обязательно. Список локализованных листингов для этой подписки. Должен содержать как минимум запись для языка по умолчанию родительского приложения.

archived
(deprecated)

boolean

Только вывод. Устарело: архивация подписки не поддерживается.

taxAndComplianceSettings

object ( SubscriptionTaxAndComplianceSettings )

Подробная информация о налогах и соблюдении законодательства.

restrictedPaymentCountries

object ( RestrictedPaymentCountries )

Необязательно. Страны, где покупка этой подписки ограничена способами оплаты, зарегистрированными в той же стране. Если пусто, ограничения по месту оплаты не налагаются.

BasePlan

Единый базовый план для подписки.

JSON-представление
{
  "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.
}
Поля
basePlanId

string

Обязательно. Неизменяемый. Уникальный идентификатор этого базового плана. Должен быть уникальным в пределах подписки и соответствовать RFC-1034. То есть этот идентификатор может содержать только строчные буквы (az), цифры (0-9) и дефисы (-) и быть длиной не более 63 символов.

state

enum ( State )

Только вывод. Состояние базового плана, т. е. активен ли он. Черновые и неактивные базовые планы можно активировать или удалить. Активные базовые планы можно сделать неактивными. Неактивные базовые планы можно отменить. Это поле нельзя изменить путем обновления ресурса. Вместо этого используйте выделенные конечные точки.

regionalConfigs[]

object ( RegionalBasePlanConfig )

Информация по данному базовому плану, касающаяся конкретного региона.

offerTags[]

object ( OfferTag )

Список из 20 пользовательских тегов, указанных для этого базового плана и возвращенных в приложение через библиотеку выставления счетов. Предложения по подписке для этого базового плана также получат эти теги предложений в библиотеке выставления счетов.

otherRegionsConfig

object ( OtherRegionsBasePlanConfig )

Информация о ценах для любых новых локаций, которые Play может запустить в будущем. Если этот пункт пропущен, BasePlan не будет автоматически доступен для любых новых локаций, которые Play может запустить в будущем.

Поле объединения base_plan_type . Тип этого базового плана. Необходимо задать ровно один. Тип базового плана неизменяем после создания базового плана. base_plan_type может быть только одним из следующих:
autoRenewingBasePlanType

object ( AutoRenewingBasePlanType )

Установите, когда базовый план будет автоматически обновляться через регулярные промежутки времени.

prepaidBasePlanType

object ( PrepaidBasePlanType )

Установите, если базовый план не продлевается автоматически по окончании расчетного периода.

installmentsBasePlanType

object ( InstallmentsBasePlanType )

Устанавливается для базовых планов с рассрочкой платежа, при которых пользователь обязуется внести определенное количество платежей.

Состояние

Текущее состояние базового плана.

Перечисления
STATE_UNSPECIFIED Неопределенное состояние.
DRAFT Базовый план в настоящее время находится в состоянии черновика и не был активирован. На этом этапе его можно безопасно удалить.
ACTIVE Базовый план активен и доступен для новых абонентов.
INACTIVE Базовый план неактивен и доступен только для существующих подписчиков.

AutoRenewingBasePlanType

Представляет собой базовый план, который автоматически продлевается по окончании периода подписки.

JSON-представление
{
  "billingPeriodDuration": string,
  "gracePeriodDuration": string,
  "accountHoldDuration": string,
  "resubscribeState": enum (ResubscribeState),
  "prorationMode": enum (SubscriptionProrationMode),
  "legacyCompatible": boolean,
  "legacyCompatibleSubscriptionOfferId": string
}
Поля
billingPeriodDuration

string

Обязательно. Неизменяемый. Период подписки, указанный в формате ISO 8601. Список допустимых периодов выставления счетов см. в справочном центре. Продолжительность неизменяема после создания базового плана.

gracePeriodDuration

string

Льготный период подписки, указанный в формате ISO 8601. Допустимые значения должны быть в днях и находиться в диапазоне от P0D до меньшего из 30D и базового расчетного периода.

Если не указано иное, будет использовано значение по умолчанию на основе расчетного периода.

Сумма gracePeriodDuration и accountHoldDuration должна быть в пределах от P30D до P60D дней включительно.

accountHoldDuration

string

Необязательно. Период удержания аккаунта подписки, указанный в формате ISO 8601. Допустимые значения должны быть в днях и находиться в диапазоне от P0D до P60D.

Если не указано иное, значение по умолчанию — P30D.

Сумма gracePeriodDuration и accountHoldDuration должна быть в пределах от P30D до P60D дней включительно.

resubscribeState

enum ( ResubscribeState )

Должны ли пользователи иметь возможность повторно подписаться на этот базовый план в Google Play. По умолчанию RESUBSCRIBE_STATE_ACTIVE, если не указано иное.

prorationMode

enum ( SubscriptionProrationMode )

Режим пропорционального распределения для базового плана определяет, что происходит, когда пользователь переключается на этот план с другого базового плана. Если не указано, по умолчанию используется CHARGE_ON_NEXT_BILLING_DATE.

legacyCompatible

boolean

Является ли обновляемый базовый план обратно совместимым.

Базовый план с обратной совместимостью возвращается устаревшим методом Google Play Billing Library querySkuDetailsAsync().

Только один обновляемый базовый план может быть отмечен как совместимый с устаревшими версиями для данной подписки.

legacyCompatibleSubscriptionOfferId

string

Идентификатор предложения подписки, совместимый с устаревшими версиями.

Предложение подписки с обратной совместимостью возвращается устаревшим методом Google Play Billing Library querySkuDetailsAsync().

Только одно предложение по подписке может быть отмечено как совместимое с устаревшими версиями для данного обновляемого базового плана.

Чтобы не предлагать подписку как совместимую с устаревшими версиями, установите это поле как пустую строку.

Повторная подпискаState

Состояние повторной подписки на базовый план.

Перечисления
RESUBSCRIBE_STATE_UNSPECIFIED Неопределенное состояние.
RESUBSCRIBE_STATE_ACTIVE Повторная подписка активна.
RESUBSCRIBE_STATE_INACTIVE Повторная подписка неактивна.

ПодпискаПропорциональныйРежим

Режим пропорционального распределения, используемый для продления базовых планов.

Перечисления
SUBSCRIPTION_PRORATION_MODE_UNSPECIFIED Неопределенный режим.
SUBSCRIPTION_PRORATION_MODE_CHARGE_ON_NEXT_BILLING_DATE Плата за новый базовый план будет взиматься с пользователей в конце текущего расчетного периода.
SUBSCRIPTION_PRORATION_MODE_CHARGE_FULL_PRICE_IMMEDIATELY Пользователи будут платить за свой новый базовый план немедленно и в полном объеме. Любой оставшийся период их существующей подписки будет использован для продления срока действия нового тарифного плана.

PrepaidBasePlanType

Представляет собой базовый план, который не продлевается автоматически по окончании срока действия базового плана и должен быть продлен пользователем вручную.

JSON-представление
{
  "billingPeriodDuration": string,
  "timeExtension": enum (TimeExtension)
}
Поля
billingPeriodDuration

string

Обязательно. Неизменяемый. Период подписки, указанный в формате ISO 8601. Список допустимых периодов выставления счетов см. в справочном центре. Продолжительность неизменяема после создания базового плана.

timeExtension

enum ( TimeExtension )

Должны ли пользователи иметь возможность продлить этот предоплаченный базовый план в Google Play. По умолчанию TIME_EXTENSION_ACTIVE, если не указано иное.

Продление времени

Продление срока действия базового плана.

Перечисления
TIME_EXTENSION_UNSPECIFIED Неопределенное состояние.
TIME_EXTENSION_ACTIVE Продление времени активно. Пользователи могут пополнять или продлевать свой предоплаченный план.
TIME_EXTENSION_INACTIVE Продление времени неактивно. Пользователи не могут пополнять или продлевать свой предоплаченный план.

РассрочкаБазовыйТипПлана

Представляет собой базовый план рассрочки, в рамках которого пользователь обязуется внести определенное количество платежей.

JSON-представление
{
  "billingPeriodDuration": string,
  "committedPaymentsCount": integer,
  "renewalType": enum (RenewalType),
  "gracePeriodDuration": string,
  "accountHoldDuration": string,
  "resubscribeState": enum (ResubscribeState),
  "prorationMode": enum (SubscriptionProrationMode)
}
Поля
billingPeriodDuration

string

Обязательно. Неизменяемый. Период подписки, указанный в формате ISO 8601. Список допустимых периодов выставления счетов см. в справочном центре. Продолжительность неизменяема после создания базового плана.

committedPaymentsCount

integer

Обязательно. Неизменяемо. Количество платежей, которые пользователь обязуется сделать. Неизменяемо после создания базового плана.

renewalType

enum ( RenewalType )

Обязательно. Неизменяемый. Тип обновления базового плана «Рассрочка». Определяет поведение в конце первоначального обязательства. Тип обновления неизменяем после создания базового плана.

gracePeriodDuration

string

Льготный период подписки, указанный в формате ISO 8601. Допустимые значения должны быть в днях и находиться в диапазоне от P0D до меньшего из 30D и базового расчетного периода.

Если не указано иное, будет использовано значение по умолчанию на основе расчетного периода.

Сумма gracePeriodDuration и accountHoldDuration должна быть в пределах от P30D до P60D дней включительно.

accountHoldDuration

string

Необязательно. Период удержания аккаунта подписки, указанный в формате ISO 8601. Допустимые значения должны быть в днях и находиться в диапазоне от P0D до P60D.

Если не указано иное, значение по умолчанию — P30D.

Сумма gracePeriodDuration и accountHoldDuration должна быть в пределах от P30D до P60D дней включительно.

resubscribeState

enum ( ResubscribeState )

Должны ли пользователи иметь возможность повторно подписаться на этот базовый план в Google Play. По умолчанию RESUBSCRIBE_STATE_ACTIVE, если не указано иное.

prorationMode

enum ( SubscriptionProrationMode )

Режим пропорционального распределения для базового плана определяет, что происходит, когда пользователь переключается на этот план с другого базового плана. Если не указано, по умолчанию используется CHARGE_ON_NEXT_BILLING_DATE.

Тип обновления

Тип обновления базового плана «Рассрочка». Определяет поведение в конце первоначального обязательства. Тип обновления неизменяем после создания базового плана.

Перечисления
RENEWAL_TYPE_UNSPECIFIED Неопределенное состояние.
RENEWAL_TYPE_RENEWS_WITHOUT_COMMITMENT Периодически продлевается на весь расчетный период без каких-либо обязательств.
RENEWAL_TYPE_RENEWS_WITH_COMMITMENT Продлевается с обязательством на тот же срок, что и первоначальное.

RegionalBasePlanConfig

Конфигурация базового плана, специфичная для региона.

JSON-представление
{
  "regionCode": string,
  "newSubscriberAvailability": boolean,
  "price": {
    object (Money)
  }
}
Поля
regionCode

string

Обязательно. Код региона, к которому применяется эта конфигурация, согласно определению ISO 3166-2, например, «США».

newSubscriberAvailability

boolean

Доступен ли базовый план в указанном регионе для новых подписчиков. Существующие подписчики не будут отменять подписку, если это значение установлено как false. Если не указано, по умолчанию будет установлено значение false.

price

object ( Money )

Цена базового плана в указанном регионе. Должна быть установлена, если базовый план доступен новым подписчикам. Должна быть установлена ​​в валюте, привязанной к указанному региону.

ДругиеРегионыБазовыйПланКонфигурация

Информация о ценах в новых местах, где может быть запущен Play.

JSON-представление
{
  "usdPrice": {
    object (Money)
  },
  "eurPrice": {
    object (Money)
  },
  "newSubscriberAvailability": boolean
}
Поля
usdPrice

object ( Money )

Обязательно. Цена в долларах США для использования в любых новых местах, где может быть запущен Play.

eurPrice

object ( Money )

Обязательно. Цена в евро для использования в любых новых местах, где может быть запущен Play.

newSubscriberAvailability

boolean

Будет ли базовый план доступен для новых подписчиков в новых регионах, где может быть запущен Play. Если не указано иное, по умолчанию будет использоваться значение false.

ПодпискаСписок

Видимые потребителю метаданные подписки.

JSON-представление
{
  "languageCode": string,
  "title": string,
  "benefits": [
    string
  ],
  "description": string
}
Поля
languageCode

string

Обязательно. Язык этого листинга, как определено BCP-47, например, "en-US".

title

string

Обязательно. Название этой подписки на языке этого листинга. Обычный текст.

benefits[]

string

Список преимуществ, отображаемых пользователю на таких платформах, как Play Store, и в потоках восстановления на языке этого листинга. Обычный текст. Упорядоченный список, содержащий не более четырех преимуществ.

description

string

Описание этой подписки на языке этого листинга. Максимальная длина - 80 символов. Обычный текст.

ОграниченныеСтраныОплаты

Страны, в которых покупка этого продукта ограничена способами оплаты, зарегистрированными в той же стране. Если пусто, ограничения по месту оплаты не налагаются.

JSON-представление
{
  "regionCodes": [
    string
  ]
}
Поля
regionCodes[]

string

Обязательно. Коды регионов, на которые налагаются ограничения по платежам, как определено в ISO 3166-2, например, «США».

Методы

archive
(deprecated)

Устарело: архивирование подписок не поддерживается.

batchGet

Читает одну или несколько подписок.

batchUpdate

Обновляет пакет подписок.

create

Создает новую подписку.

delete

Удаляет подписку.

get

Читает одну подписку.

list

Перечисляет все подписки в указанном приложении.

patch

Обновляет существующую подписку.
,

Ресурс: Подписка

Единая подписка на приложение.

JSON-представление
{
  "packageName": string,
  "productId": string,
  "basePlans": [
    {
      object (BasePlan)
    }
  ],
  "listings": [
    {
      object (SubscriptionListing)
    }
  ],
  "archived": boolean,
  "taxAndComplianceSettings": {
    object (SubscriptionTaxAndComplianceSettings)
  },
  "restrictedPaymentCountries": {
    object (RestrictedPaymentCountries)
  }
}
Поля
packageName

string

Неизменяемый. Имя пакета родительского приложения.

productId

string

Неизменяемый. Уникальный идентификатор продукта. Уникален в пределах родительского приложения. Идентификаторы продуктов должны состоять из строчных букв (az), цифр (0-9), подчеркиваний (_) и точек (.). Он должен начинаться со строчной буквы или цифры и иметь длину от 1 до 40 (включительно) символов.

basePlans[]

object ( BasePlan )

Набор базовых планов для этой подписки. Представляет цены и продолжительность подписки, если другие предложения не применяются.

listings[]

object ( SubscriptionListing )

Обязательно. Список локализованных листингов для этой подписки. Должен содержать как минимум запись для языка по умолчанию родительского приложения.

archived
(deprecated)

boolean

Только вывод. Устарело: архивация подписки не поддерживается.

taxAndComplianceSettings

object ( SubscriptionTaxAndComplianceSettings )

Подробная информация о налогах и соблюдении законодательства.

restrictedPaymentCountries

object ( RestrictedPaymentCountries )

Необязательно. Страны, где покупка этой подписки ограничена способами оплаты, зарегистрированными в той же стране. Если пусто, ограничения по месту оплаты не налагаются.

BasePlan

Единый базовый план для подписки.

JSON-представление
{
  "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.
}
Поля
basePlanId

string

Обязательно. Неизменяемый. Уникальный идентификатор этого базового плана. Должен быть уникальным в пределах подписки и соответствовать RFC-1034. То есть этот идентификатор может содержать только строчные буквы (az), цифры (0-9) и дефисы (-) и быть длиной не более 63 символов.

state

enum ( State )

Только вывод. Состояние базового плана, т. е. активен ли он. Черновые и неактивные базовые планы можно активировать или удалить. Активные базовые планы можно сделать неактивными. Неактивные базовые планы можно отменить. Это поле нельзя изменить путем обновления ресурса. Вместо этого используйте выделенные конечные точки.

regionalConfigs[]

object ( RegionalBasePlanConfig )

Информация по данному базовому плану, касающаяся конкретного региона.

offerTags[]

object ( OfferTag )

Список из 20 пользовательских тегов, указанных для этого базового плана и возвращенных в приложение через библиотеку выставления счетов. Предложения по подписке для этого базового плана также получат эти теги предложений в библиотеке выставления счетов.

otherRegionsConfig

object ( OtherRegionsBasePlanConfig )

Информация о ценах для любых новых локаций, которые Play может запустить в будущем. Если этот пункт пропущен, BasePlan не будет автоматически доступен для любых новых локаций, которые Play может запустить в будущем.

Поле объединения base_plan_type . Тип этого базового плана. Необходимо задать ровно один. Тип базового плана неизменяем после создания базового плана. base_plan_type может быть только одним из следующих:
autoRenewingBasePlanType

object ( AutoRenewingBasePlanType )

Установите, когда базовый план будет автоматически обновляться через регулярные промежутки времени.

prepaidBasePlanType

object ( PrepaidBasePlanType )

Установите, если базовый план не продлевается автоматически по окончании расчетного периода.

installmentsBasePlanType

object ( InstallmentsBasePlanType )

Устанавливается для базовых планов с рассрочкой платежа, при которых пользователь обязуется внести определенное количество платежей.

Состояние

Текущее состояние базового плана.

Перечисления
STATE_UNSPECIFIED Неопределенное состояние.
DRAFT Базовый план в настоящее время находится в состоянии черновика и не был активирован. На этом этапе его можно безопасно удалить.
ACTIVE Базовый план активен и доступен для новых абонентов.
INACTIVE Базовый план неактивен и доступен только для существующих подписчиков.

AutoRenewingBasePlanType

Представляет собой базовый план, который автоматически продлевается по окончании периода подписки.

JSON-представление
{
  "billingPeriodDuration": string,
  "gracePeriodDuration": string,
  "accountHoldDuration": string,
  "resubscribeState": enum (ResubscribeState),
  "prorationMode": enum (SubscriptionProrationMode),
  "legacyCompatible": boolean,
  "legacyCompatibleSubscriptionOfferId": string
}
Поля
billingPeriodDuration

string

Обязательно. Неизменяемый. Период подписки, указанный в формате ISO 8601. Список допустимых периодов выставления счетов см. в справочном центре. Продолжительность неизменяема после создания базового плана.

gracePeriodDuration

string

Льготный период подписки, указанный в формате ISO 8601. Допустимые значения должны быть в днях и находиться в диапазоне от P0D до меньшего из 30D и базового расчетного периода.

Если не указано иное, будет использовано значение по умолчанию на основе расчетного периода.

Сумма gracePeriodDuration и accountHoldDuration должна быть в пределах от P30D до P60D дней включительно.

accountHoldDuration

string

Необязательно. Период удержания аккаунта подписки, указанный в формате ISO 8601. Допустимые значения должны быть в днях и находиться в диапазоне от P0D до P60D.

Если не указано иное, значение по умолчанию — P30D.

Сумма gracePeriodDuration и accountHoldDuration должна быть в пределах от P30D до P60D дней включительно.

resubscribeState

enum ( ResubscribeState )

Должны ли пользователи иметь возможность повторно подписаться на этот базовый план в Google Play. По умолчанию RESUBSCRIBE_STATE_ACTIVE, если не указано иное.

prorationMode

enum ( SubscriptionProrationMode )

Режим пропорционального распределения для базового плана определяет, что происходит, когда пользователь переключается на этот план с другого базового плана. Если не указано, по умолчанию используется CHARGE_ON_NEXT_BILLING_DATE.

legacyCompatible

boolean

Является ли обновляемый базовый план обратно совместимым.

Базовый план с обратной совместимостью возвращается устаревшим методом Google Play Billing Library querySkuDetailsAsync().

Только один обновляемый базовый план может быть отмечен как совместимый с устаревшими версиями для данной подписки.

legacyCompatibleSubscriptionOfferId

string

Идентификатор предложения подписки, совместимый с устаревшими версиями.

Предложение подписки с обратной совместимостью возвращается устаревшим методом Google Play Billing Library querySkuDetailsAsync().

Только одно предложение по подписке может быть отмечено как совместимое с устаревшими версиями для данного обновляемого базового плана.

Чтобы не предлагать подписку как совместимую с устаревшими версиями, установите это поле как пустую строку.

Повторная подпискаState

Состояние повторной подписки на базовый план.

Перечисления
RESUBSCRIBE_STATE_UNSPECIFIED Неопределенное состояние.
RESUBSCRIBE_STATE_ACTIVE Повторная подписка активна.
RESUBSCRIBE_STATE_INACTIVE Повторная подписка неактивна.

ПодпискаПропорциональныйРежим

Режим пропорционального распределения, используемый для продления базовых планов.

Перечисления
SUBSCRIPTION_PRORATION_MODE_UNSPECIFIED Неопределенный режим.
SUBSCRIPTION_PRORATION_MODE_CHARGE_ON_NEXT_BILLING_DATE Плата за новый базовый план будет взиматься с пользователей в конце текущего расчетного периода.
SUBSCRIPTION_PRORATION_MODE_CHARGE_FULL_PRICE_IMMEDIATELY Пользователи будут платить за свой новый базовый план немедленно и в полном объеме. Любой оставшийся период их существующей подписки будет использован для продления срока действия нового тарифного плана.

PrepaidBasePlanType

Представляет собой базовый план, который не продлевается автоматически по окончании срока действия базового плана и должен быть продлен пользователем вручную.

JSON-представление
{
  "billingPeriodDuration": string,
  "timeExtension": enum (TimeExtension)
}
Поля
billingPeriodDuration

string

Обязательно. Неизменяемый. Период подписки, указанный в формате ISO 8601. Список допустимых периодов выставления счетов см. в справочном центре. Продолжительность неизменяема после создания базового плана.

timeExtension

enum ( TimeExtension )

Должны ли пользователи иметь возможность продлить этот предоплаченный базовый план в Google Play. По умолчанию TIME_EXTENSION_ACTIVE, если не указано иное.

Продление времени

Продление срока действия базового плана.

Перечисления
TIME_EXTENSION_UNSPECIFIED Неопределенное состояние.
TIME_EXTENSION_ACTIVE Продление времени активно. Пользователи могут пополнять или продлевать свой предоплаченный план.
TIME_EXTENSION_INACTIVE Продление времени неактивно. Пользователи не могут пополнять или продлевать свой предоплаченный план.

РассрочкаБазовыйТипПлана

Представляет собой базовый план рассрочки, в рамках которого пользователь обязуется внести определенное количество платежей.

JSON-представление
{
  "billingPeriodDuration": string,
  "committedPaymentsCount": integer,
  "renewalType": enum (RenewalType),
  "gracePeriodDuration": string,
  "accountHoldDuration": string,
  "resubscribeState": enum (ResubscribeState),
  "prorationMode": enum (SubscriptionProrationMode)
}
Поля
billingPeriodDuration

string

Обязательно. Неизменяемый. Период подписки, указанный в формате ISO 8601. Список допустимых периодов выставления счетов см. в справочном центре. Продолжительность неизменяема после создания базового плана.

committedPaymentsCount

integer

Обязательно. Неизменяемо. Количество платежей, которые пользователь обязуется сделать. Неизменяемо после создания базового плана.

renewalType

enum ( RenewalType )

Обязательно. Неизменяемый. Тип обновления базового плана «Рассрочка». Определяет поведение в конце первоначального обязательства. Тип обновления неизменяем после создания базового плана.

gracePeriodDuration

string

Льготный период подписки, указанный в формате ISO 8601. Допустимые значения должны быть в днях и находиться в диапазоне от P0D до меньшего из 30D и базового расчетного периода.

Если не указано иное, будет использовано значение по умолчанию на основе расчетного периода.

Сумма gracePeriodDuration и accountHoldDuration должна быть в пределах от P30D до P60D дней включительно.

accountHoldDuration

string

Необязательно. Период удержания аккаунта подписки, указанный в формате ISO 8601. Допустимые значения должны быть в днях и находиться в диапазоне от P0D до P60D.

Если не указано иное, значение по умолчанию — P30D.

Сумма gracePeriodDuration и accountHoldDuration должна быть в пределах от P30D до P60D дней включительно.

resubscribeState

enum ( ResubscribeState )

Должны ли пользователи иметь возможность повторно подписаться на этот базовый план в Google Play. По умолчанию RESUBSCRIBE_STATE_ACTIVE, если не указано иное.

prorationMode

enum ( SubscriptionProrationMode )

Режим пропорционального распределения для базового плана определяет, что происходит, когда пользователь переключается на этот план с другого базового плана. Если не указано, по умолчанию используется CHARGE_ON_NEXT_BILLING_DATE.

Тип обновления

Тип обновления базового плана «Рассрочка». Определяет поведение в конце первоначального обязательства. Тип обновления неизменяем после создания базового плана.

Перечисления
RENEWAL_TYPE_UNSPECIFIED Неопределенное состояние.
RENEWAL_TYPE_RENEWS_WITHOUT_COMMITMENT Периодически продлевается на весь расчетный период без каких-либо обязательств.
RENEWAL_TYPE_RENEWS_WITH_COMMITMENT Продлевается с обязательством на тот же срок, что и первоначальное.

RegionalBasePlanConfig

Конфигурация базового плана, специфичная для региона.

JSON-представление
{
  "regionCode": string,
  "newSubscriberAvailability": boolean,
  "price": {
    object (Money)
  }
}
Поля
regionCode

string

Обязательно. Код региона, к которому применяется эта конфигурация, согласно определению ISO 3166-2, например, «США».

newSubscriberAvailability

boolean

Доступен ли базовый план в указанном регионе для новых подписчиков. Существующие подписчики не будут отменять подписку, если это значение установлено как false. Если не указано, по умолчанию будет установлено значение false.

price

object ( Money )

Цена базового плана в указанном регионе. Должна быть установлена, если базовый план доступен новым подписчикам. Должна быть установлена ​​в валюте, привязанной к указанному региону.

ДругиеРегионыБазовыйПланКонфигурация

Информация о ценах в новых местах, где может быть запущен Play.

JSON-представление
{
  "usdPrice": {
    object (Money)
  },
  "eurPrice": {
    object (Money)
  },
  "newSubscriberAvailability": boolean
}
Поля
usdPrice

object ( Money )

Обязательно. Цена в долларах США для использования в любых новых местах, где может быть запущен Play.

eurPrice

object ( Money )

Обязательно. Цена в евро для использования в любых новых местах, где может быть запущен Play.

newSubscriberAvailability

boolean

Будет ли базовый план доступен для новых подписчиков в новых регионах, где может быть запущен Play. Если не указано иное, по умолчанию будет использоваться значение false.

ПодпискаСписок

Видимые потребителю метаданные подписки.

JSON-представление
{
  "languageCode": string,
  "title": string,
  "benefits": [
    string
  ],
  "description": string
}
Поля
languageCode

string

Обязательно. Язык этого листинга, как определено BCP-47, например, "en-US".

title

string

Обязательно. Название этой подписки на языке этого листинга. Обычный текст.

benefits[]

string

Список преимуществ, отображаемых пользователю на таких платформах, как Play Store, и в потоках восстановления на языке этого листинга. Обычный текст. Упорядоченный список, содержащий не более четырех преимуществ.

description

string

Описание этой подписки на языке этого листинга. Максимальная длина - 80 символов. Обычный текст.

ОграниченныеСтраныОплаты

Страны, в которых покупка этого продукта ограничена способами оплаты, зарегистрированными в той же стране. Если пусто, ограничения по месту оплаты не налагаются.

JSON-представление
{
  "regionCodes": [
    string
  ]
}
Поля
regionCodes[]

string

Обязательно. Коды регионов, на которые налагаются ограничения по платежам, как определено в ISO 3166-2, например, «США».

Методы

archive
(deprecated)

Устарело: архивирование подписок не поддерживается.

batchGet

Читает одну или несколько подписок.

batchUpdate

Обновляет пакет подписок.

create

Создает новую подписку.

delete

Удаляет подписку.

get

Читает одну подписку.

list

Перечисляет все подписки в указанном приложении.

patch

Обновляет существующую подписку.