REST Resource: monetization.subscriptions

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

string

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

string

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

object ( BasePlan )

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

object ( SubscriptionListing )

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

boolean

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

object ( SubscriptionTaxAndComplianceSettings )

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

object ( RestrictedPaymentCountries )

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

{
  "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

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

enum ( State )

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

object ( RegionalBasePlanConfig )

Информация для этого базового плана, специфичная для региона.

object ( OfferTag )

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

object ( OtherRegionsBasePlanConfig )

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

object ( AutoRenewingBasePlanType )

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

object ( PrepaidBasePlanType )

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

object ( InstallmentsBasePlanType )

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

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

string

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

string

Льготный период подписки, указанный в формате ISO 8601. Допустимые значения: P0D (ноль дней), P3D (3 дня), P7D (7 дней), P14D (14 дней) и P30D (30 дней). Если не указано, будет использоваться значение по умолчанию, основанное на продолжительности повторяющегося периода.

string

Необязательный. Период хранения учетной записи подписки, указанный в формате ISO 8601. Допустимые значения должны быть указаны в ДНЯХ и в диапазоне от P0D (ноль дней) до P30D (30 дней). Если не указано, значение по умолчанию — P30D (30 дней).

enum ( ResubscribeState )

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

enum ( SubscriptionProrationMode )

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

boolean

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

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

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

string

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

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

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

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

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

string

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

enum ( TimeExtension )

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

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

string

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

integer

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

enum ( RenewalType )

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

string

Льготный период подписки, указанный в формате ISO 8601. Допустимые значения: P0D (ноль дней), P3D (3 дня), P7D (7 дней), P14D (14 дней) и P30D (30 дней). Если не указано, будет использоваться значение по умолчанию, основанное на продолжительности повторяющегося периода.

string

Необязательный. Срок хранения учетной записи подписки, указанный исключительно в днях и в формате ISO 8601. Допустимые значения: от P0D (ноль дней) до P30D (30 дней). Если не указано, значение по умолчанию — P30D (30 дней).

enum ( ResubscribeState )

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

enum ( SubscriptionProrationMode )

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

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

string

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

boolean

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

object ( Money )

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

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

object ( Money )

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

object ( Money )

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

boolean

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

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

string

Необходимый. Язык этого списка, как определено BCP-47, например «en-US».

string

Необходимый. Название этой подписки на языке этого объявления. Простой текст.

string

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

string

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

{
  "regionCodes": [
    string
  ]
}

string

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