POST /api/v2/server-side-api/purchase/set/transaction/

Установить транзакцию

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

Обновление существующей подписки: Чтобы обновить billing_issue_detected_at или renew_status_changed_at без генерации нового события subscription_renewed, повторно используйте существующий store_transaction_id (в рамках того же store_original_transaction_id). Передача нового store_transaction_id расценивается как новая транзакция и вызывает событие subscription_renewed.

Header parameters

adapty-customer-user-idstring

Уникальный идентификатор пользователя в вашей системе. Требуется указать либо adapty-customer-user-id, либо adapty-profile-id.

adapty-profile-idstring

Уникальный идентификатор профиля в вашей системе. Наилучший вариант при работе с анонимными профилями. Требуется указать либо adapty-customer-user-id, либо adapty-profile-id.

Request body

Option 1 — object

Данные транзакции для разовой покупки

purchase_typestringrequired

Тип покупки

One of: "one_time_purchase"

storestringrequired

Стор, в котором была совершена покупка. Распространённые значения включают app_store, play_store, stripe, paddle или любой пользовательский идентификатор стора

environmentstring

Среда, в которой была совершена покупка

One of: "Production", "Sandbox"

store_product_idstringrequired

ID продукта в сторе

store_transaction_idstringrequired

ID транзакции в сторе. Максимум 50 символов. Идентификаторы транзакций PayPal и некоторых пользовательских сторов могут превышать это ограничение — обрежьте или хэшируйте значение перед отправкой, иначе запрос завершится ошибкой.

store_original_transaction_idstringrequired

Оригинальный ID транзакции в сторе

is_family_sharedboolean

Является ли покупка семейной

priceobjectrequired

countrystringrequired

Код страны в формате ISO 3166-1 alpha-2, например US

currencystringrequired

Код валюты в формате ISO 4217, например USD

valuenumberrequired

Значение цены

purchased_atstringrequired

Время совершения покупки

variation_idstring

ID варианта для A/B-тестирования

offerobject

categorystringrequired

Категория предложения

One of: "introductory", "promotional", "offer_code", "win_back"

typestringrequired

Тип предложения

One of: "free_trial", "pay_as_you_go", "pay_up_front"

idstring

Идентификатор предложения

refunded_atstring

Время возврата покупки

cancellation_reasonstring

Причина отмены

One of: "billing_error", "cancelled_by_developer", "new_subscription_replace", "price_increase", "product_was_not_available", "refund", "unknown", "upgraded", "voluntarily_cancelled", "adapty_revoked"

Option 2 — object

Данные транзакции для покупки подписки

purchase_typestringrequired

Тип покупки

One of: "subscription"

storestringrequired

environmentstring

Среда, в которой была совершена покупка

One of: "Production", "Sandbox"

store_product_idstringrequired

ID продукта в сторе

store_transaction_idstringrequired

ID транзакции в сторе. Максимум 50 символов. Идентификаторы транзакций PayPal и некоторых пользовательских сторов могут превышать это ограничение — обрежьте или хешируйте значение перед отправкой, иначе запрос завершится ошибкой.

store_original_transaction_idstringrequired

Оригинальный ID транзакции в сторе

is_family_sharedboolean

Является ли покупка семейной

priceobjectrequired

countrystringrequired

Код страны в формате ISO 3166-1 alpha-2, например US

currencystringrequired

Код валюты в формате ISO 4217, например USD

valuenumberrequired

Значение цены

purchased_atstringrequired

Когда была совершена покупка

variation_idstring

ID варианта для A/B-тестирования

offerobject

categorystringrequired

Категория предложения

One of: "introductory", "promotional", "offer_code", "win_back"

typestringrequired

Тип предложения

One of: "free_trial", "pay_as_you_go", "pay_up_front"

idstring

Идентификатор предложения

refunded_atstring

Когда покупка была возвращена

cancellation_reasonstring

Причина отмены

originally_purchased_atstringrequired

Когда подписка была приобретена впервые

expires_atstringrequired

Когда истекает подписка

renew_statusbooleanrequired

Будет ли подписка продлена

renew_status_changed_atstring

Когда был изменён статус продления

billing_issue_detected_atstring

Когда была обнаружена проблема с оплатой

grace_period_expires_atstring

Когда истекает льготный период

Responses

Транзакция успешно записана

Schema

dataobjectrequired

app_idstringrequired

Внутренний ID вашего приложения

profile_idstringrequired

ID профиля Adapty

customer_user_idstringrequired

ID вашего пользователя в вашей системе

total_revenue_usdnumberrequired

Числовое значение с плавающей точкой, представляющее общий доход в USD, полученный по профилю

segment_hashstringrequired

Внутренний параметр

timestampintegerrequired

Время ответа в миллисекундах, необходимо для разрешения состояния гонки

custom_attributesarray of objectrequired

Для профиля допускается задавать не более 30 пользовательских атрибутов

keystringrequired

Ключ должен быть строкой не более 30 символов. Допускаются только буквы, цифры, дефисы, точки и символы подчёркивания

valuestring | numberrequired

Значение атрибута должно содержать не более 50 символов. В качестве значений допускаются только строки и числа с плавающей точкой

access_levelsarray of objectrequired

Массив объектов уровня доступа. Пустой массив, если у пользователя нет уровней доступа

access_level_idstring

Идентификатор уровня доступа

storestring

Стор, в котором был приобретён уровень доступа

store_product_idstring

Идентификатор продукта в сторе. Для годового тарифного плана App Store с обязательством идентификатор заканчивается на :monthly.

store_base_plan_idstring

Идентификатор базового тарифного плана в сторе

store_transaction_idstring

Идентификатор транзакции в сторе

store_original_transaction_idstring

Идентификатор оригинальной транзакции в сторе

offerallOf

Данные об офере, если был применён promotional offer или introductory offer

categorystring

Категория предложения

One of: "introductory", "promotional", "offer_code", "win_back"

typestring

Тип предложения

One of: "free_trial", "pay_as_you_go", "pay_up_front"

idstring

Идентификатор предложения

starts_atstring

Когда начинается уровень доступа

purchased_atstring

Когда был приобретён уровень доступа

originally_purchased_atstring

Когда уровень доступа был приобретён впервые

expires_atstring

Когда истекает уровень доступа

renewal_cancelled_atstring

Когда было отменено продление

billing_issue_detected_atstring

Когда была обнаружена проблема с оплатой

is_in_grace_periodboolean

Находится ли уровень доступа в льготном периоде

cancellation_reasonstring

Причина отмены

subscriptionsarray of objectrequired

Массив объектов подписки. Пустой массив, если у пользователя нет подписок

storestring

Стор, в котором была оформлена подписка

store_product_idstring

ID продукта в сторе. Для 12-месячного тарифного плана с обязательством в App Store ID заканчивается на :monthly.

store_base_plan_idstring

ID базового тарифного плана в сторе

store_transaction_idstring

ID транзакции в сторе

store_original_transaction_idstring

Исходный ID транзакции в сторе

offerallOf

Детали офера, если был применён promotional offer или introductory offer

categorystring

Категория предложения

One of: "introductory", "promotional", "offer_code", "win_back"

typestring

Тип предложения

One of: "free_trial", "pay_as_you_go", "pay_up_front"

idstring

Идентификатор предложения

environmentstring

Среда (Sandbox, Production)

purchased_atstring

Когда была оформлена подписка

originally_purchased_atstring

Когда подписка была оформлена впервые

expires_atstring

Когда истекает подписка

renewal_cancelled_atstring

Когда было отменено продление. Для 12-месячного тарифного плана с обязательством остаётся null после отмены подписчиком, поскольку ежемесячные платежи продолжаются. Используйте commitment.will_renew вместо этого.

billing_issue_detected_atstring

Когда была обнаружена проблема с оплатой

is_in_grace_periodboolean

Находится ли подписка в льготном периоде

cancellation_reasonstring

Причина отмены

commitmentallOf

12-месячное обязательство тарифного плана с обязательством App Store. Не задаётся для других подписок.

will_renewboolean

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

billing_period_numberinteger

Номер текущего ежемесячного платежа в рамках периода обязательств, начиная с 1

total_billing_periodsinteger

Количество ежемесячных платежей в рамках периода обязательств

expires_atstring

Дата окончания периода обязательств. Собственное поле expires_at подписки соответствует концу текущего оплаченного месяца.

non_subscriptionsarray of objectrequired

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

purchase_idstring

Уникальный идентификатор покупки

storestring

Стор, в котором была совершена покупка

store_product_idstring

ID продукта в сторе

store_base_plan_idstring

ID базового плана в сторе

store_transaction_idstring

ID транзакции в сторе

store_original_transaction_idstring

Оригинальный ID транзакции в сторе

purchased_atstring

Дата и время совершения покупки

environmentstring

Среда (Sandbox, Production)

is_refundboolean

Является ли покупка возвратом средств

is_consumableboolean

Является ли покупка расходуемой

Некорректный запрос

Schema

errorsarray of objectrequired

sourcestring

Источник ошибки

errorsarray of string

Массив сообщений об ошибках

error_codestringrequired

Краткое название ошибки

status_codeintegerrequired

HTTP-код статуса

Не авторизован

Schema

errorsarray of objectrequired

sourcestring

Источник ошибки

errorsarray of string

Массив сообщений об ошибках

error_codestringrequired

Краткое название ошибки

status_codeintegerrequired

HTTP-код статуса

Профиль не найден

Schema

errorsarray of objectrequired

sourcestring

Источник ошибки

errorsarray of string

Массив сообщений об ошибках

error_codestringrequired

Краткое название ошибки

status_codeintegerrequired

HTTP-код статуса

Внутренняя ошибка сервера

Try it

Authorization

Header parameters

adapty-customer-user-id

adapty-profile-id

Body

curl --request POST \
  --url 'https://api.adapty.io/api/v2/server-side-api/purchase/set/transaction/' \
  --header 'Authorization: Api-Key YOUR_SECRET_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "purchase_type": "one_time_purchase",
    "store": "app_store",
    "environment": "Production",
    "store_product_id": "premium_lifetime",
    "store_transaction_id": "1000000123456789",
    "store_original_transaction_id": "1000000123456789",
    "is_family_shared": false,
    "price": {
      "country": "US",
      "currency": "USD",
      "value": 9.99
    },
    "purchased_at": "2024-01-15T10:30:00Z",
    "variation_id": "variation_123",
    "offer": null,
    "refunded_at": null,
    "cancellation_reason": null
  }'

const response = await fetch('https://api.adapty.io/api/v2/server-side-api/purchase/set/transaction/', {
  method: 'POST',
  headers: {
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "purchase_type": "one_time_purchase",
    "store": "app_store",
    "environment": "Production",
    "store_product_id": "premium_lifetime",
    "store_transaction_id": "1000000123456789",
    "store_original_transaction_id": "1000000123456789",
    "is_family_shared": false,
    "price": {
      "country": "US",
      "currency": "USD",
      "value": 9.99
    },
    "purchased_at": "2024-01-15T10:30:00Z",
    "variation_id": "variation_123",
    "offer": null,
    "refunded_at": null,
    "cancellation_reason": null
  }),
});
const data = await response.json();

import requests

response = requests.post('https://api.adapty.io/api/v2/server-side-api/purchase/set/transaction/', headers={
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
}, json={
      "purchase_type": "one_time_purchase",
      "store": "app_store",
      "environment": "Production",
      "store_product_id": "premium_lifetime",
      "store_transaction_id": "1000000123456789",
      "store_original_transaction_id": "1000000123456789",
      "is_family_shared": False,
      "price": {
        "country": "US",
        "currency": "USD",
        "value": 9.99
      },
      "purchased_at": "2024-01-15T10:30:00Z",
      "variation_id": "variation_123",
      "offer": None,
      "refunded_at": None,
      "cancellation_reason": None
    })
data = response.json()