REST Resource: purchases.subscriptions

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

Ресурс SubscriptionPurchase указывает статус покупки подписки пользователем.

JSON-представление 
{
  "kind": string,
  "startTimeMillis": string,
  "expiryTimeMillis": string,
  "autoResumeTimeMillis": string,
  "autoRenewing": boolean,
  "priceCurrencyCode": string,
  "priceAmountMicros": string,
  "introductoryPriceInfo": {
    object (IntroductoryPriceInfo)
  },
  "countryCode": string,
  "developerPayload": string,
  "paymentState": integer,
  "cancelReason": integer,
  "userCancellationTimeMillis": string,
  "cancelSurveyResult": {
    object (SubscriptionCancelSurveyResult)
  },
  "orderId": string,
  "linkedPurchaseToken": string,
  "purchaseType": integer,
  "priceChange": {
    object (SubscriptionPriceChange)
  },
  "profileName": string,
  "emailAddress": string,
  "givenName": string,
  "familyName": string,
  "profileId": string,
  "acknowledgementState": integer,
  "externalAccountId": string,
  "promotionType": integer,
  "promotionCode": string,
  "obfuscatedExternalAccountId": string,
  "obfuscatedExternalProfileId": string
}
Поля
kind

string

Этот тип представляет собой объект subscriptionPurchase в сервисе androidpublisher.

startTimeMillis

string ( int64 format)

Время предоставления подписки в миллисекундах с начала эпохи.

expiryTimeMillis

string ( int64 format)

Время истечения срока действия подписки в миллисекундах с начала эпохи.

autoResumeTimeMillis

string ( int64 format)

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

autoRenewing

boolean

Будет ли подписка автоматически продлена по истечении текущего срока действия.

priceCurrencyCode

string

Код валюты ISO 4217 для цены подписки. Например, если цена указана в британских фунтах стерлингов, priceCurrencyCode будет "GBP".

priceAmountMicros

string ( int64 format)

Цена подписки, Для стран с исключением налогов цена не включает налог. Для стран с учетом налогов цена включает налог. Цена выражается в микроединицах, где 1 000 000 микроединиц представляют одну единицу валюты. Например, если цена подписки составляет €1,99, priceAmountMicros равно 1990000.

introductoryPriceInfo

object ( IntroductoryPriceInfo )

Информация о начальной цене подписки. Она присутствует только в том случае, если подписка была приобретена по начальной цене.

Это поле не указывает на то, что подписка в настоящее время находится в периоде ознакомительной цены.

countryCode

string

Код страны/региона выставления счета по стандарту ISO 3166-1 alpha-2 пользователя на момент оформления подписки.

developerPayload

string

Указанная разработчиком строка, содержащая дополнительную информацию о заказе.

paymentState

integer

Состояние оплаты подписки. Возможные значения: 0. Ожидание оплаты 1. Получение оплаты 2. Бесплатная пробная версия 3. Ожидание отложенного обновления/понижения

Отсутствует для отмененных, истекших подписок.

cancelReason

integer

Причина, по которой подписка была отменена или не продлевается автоматически. Возможные значения: 0. Пользователь отменил подписку 1. Подписка была отменена системой, например, из-за проблем с выставлением счетов 2. Подписка была заменена новой подпиской 3. Подписка была отменена разработчиком

userCancellationTimeMillis

string ( int64 format)

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

cancelSurveyResult

object ( SubscriptionCancelSurveyResult )

Информация, предоставляемая пользователем при завершении процедуры отмены подписки (опрос о причине отмены).

orderId

string

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

linkedPurchaseToken

string

Токен покупки исходной покупки, если эта подписка является одной из следующих: 0. Повторная регистрация отмененной, но не истекшей подписки 1. Повышение/понижение предыдущей подписки

Например, предположим, что пользователь изначально регистрируется, и вы получаете токен покупки X, затем пользователь отменяет подписку и проходит процедуру повторной регистрации (до истечения срока действия его подписки), и вы получаете токен покупки Y, и, наконец, пользователь обновляет свою подписку, и вы получаете токен покупки Z. Если вы вызываете этот API с токеном покупки Z, это поле будет установлено на Y. Если вы вызываете этот API с токеном покупки Y, это поле будет установлено на X. Если вы вызываете этот API с токеном покупки X, это поле не будет установлено.

purchaseType

integer

Тип покупки подписки. Это поле задается только в том случае, если эта покупка не была сделана с использованием стандартного потока выставления счетов в приложении. Возможные значения: 0. Тест (т. е. куплено с учетной записи тестирования лицензии) 1. Промо (т. е. куплено с использованием промокода)

priceChange

object ( SubscriptionPriceChange )

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

После продления подписки по новой цене или отмены подписки информация об изменении цены возвращаться не будет.

profileName

string

Имя профиля пользователя при покупке подписки. Присутствует только для покупок, сделанных с помощью «Подписаться через Google».

emailAddress

string

Адрес электронной почты пользователя при покупке подписки. Присутствует только для покупок, сделанных с помощью «Подписаться через Google».

givenName

string

Имя пользователя при покупке подписки. Присутствует только для покупок, сделанных с помощью «Подписаться через Google».

familyName

string

Фамилия пользователя при покупке подписки. Присутствует только для покупок, сделанных с помощью «Подписаться через Google».

profileId

string

Идентификатор профиля Google пользователя при покупке подписки. Присутствует только для покупок, сделанных с помощью «Подписаться через Google».

acknowledgementState

integer

Состояние подтверждения подписного продукта. Возможные значения: 0. Еще не подтверждено 1. Подтверждено

externalAccountId

string

Идентификатор учетной записи пользователя в стороннем сервисе. Присутствует только в том случае, если привязка учетной записи произошла в рамках процесса покупки подписки.

promotionType

integer

Тип рекламной акции, применяемой к этой покупке. Это поле задается только в том случае, если рекламная акция применяется при покупке подписки. Возможные значения: 0. Одноразовый код 1. Код красоты

promotionCode

string

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

obfuscatedExternalAccountId

string

Запутанная версия идентификатора, которая однозначно связана с учетной записью пользователя в вашем приложении. Присутствует для следующих покупок: * Если привязка учетной записи произошла как часть процесса покупки подписки. * Она была указана с помощью https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid при совершении покупки.

obfuscatedExternalProfileId

string

Запутанная версия идентификатора, которая однозначно связана с профилем пользователя в вашем приложении. Присутствует только если указано с помощью https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid при совершении покупки.

ВводнаяЦенаИнформация

Содержит ознакомительную информацию о ценах на подписку.

JSON-представление 
{
  "introductoryPriceCurrencyCode": string,
  "introductoryPriceAmountMicros": string,
  "introductoryPricePeriod": string,
  "introductoryPriceCycles": integer
}
Поля
introductoryPriceCurrencyCode

string

Код валюты ISO 4217 для начальной цены подписки. Например, если цена указана в британских фунтах стерлингов, priceCurrencyCode будет "GBP".

introductoryPriceAmountMicros

string ( int64 format)

Начальная цена подписки, не включая налог. Валюта та же, что и priceCurrencyCode. Цена выражена в микроединицах, где 1 000 000 микроединиц представляют одну единицу валюты. Например, если цена подписки составляет €1,99, priceAmountMicros будет 1990000.

introductoryPricePeriod

string

Период действия начальной цены, указанный в формате ISO 8601. Распространенные значения (но не ограничиваясь ими) «P1W» (одна неделя), «P1M» (один месяц), «P3M» (три месяца), «P6M» (шесть месяцев) и «P1Y» (один год).

introductoryPriceCycles

integer

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

ПодпискаОтменаОпросРезультат

Информация, предоставляемая пользователем при завершении процедуры отмены подписки (опрос о причине отмены).

JSON-представление 
{
  "cancelSurveyReason": integer,
  "userInputCancelReason": string
}
Поля
cancelSurveyReason

integer

Причина отмены, которую пользователь выбрал в опросе. Возможные значения: 0. Другое 1. Я недостаточно пользуюсь этой услугой 2. Технические проблемы 3. Причины, связанные со стоимостью 4. Я нашел лучшее приложение

userInputCancelReason

string

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

ПодпискаЦенаИзменить

Содержит информацию об изменении цены для подписки, которая может использоваться для управления пользовательским путем изменения цены в приложении. Это может быть в форме запроса подтверждения от пользователя или настройки опыта для успешной конверсии.

JSON-представление 
{
  "newPrice": {
    object (Price)
  },
  "state": integer
}
Поля
newPrice

object ( Price )

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

state

integer

Текущее состояние изменения цены. Возможные значения: 0. Не выполнено: Состояние для ожидающего изменения цены, ожидающего согласия пользователя. В этом состоянии вы можете дополнительно запросить подтверждение от пользователя с помощью API In-App. 1. Принято: Состояние для принятого изменения цены, с которым подписка будет продлена, если она не будет отменена. Изменение цены вступит в силу в будущем, когда подписка будет продлена. Обратите внимание, что изменение может не произойти при следующем продлении подписки.

Методы

acknowledge

 Подтверждает покупку подписки.

cancel

 Отменяет покупку подписки пользователем.

defer

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

get
(deprecated)

 Устарело: вместо этого используйте purchases.subscriptionsv2.get.

refund
(deprecated)

 Устарело: вместо этого используйте orders.refund.

revoke
(deprecated)

 Устарело: вместо этого используйте purchases.subscriptionsv2.revoke.