English 中文TürkçeРусскийFrançaisTiếng ViệtEspañol日本語
POST /api/v2/server-side-api/purchase/paddle/token/validate/

Валидация покупки Paddle

Copy as Markdown

Валидирует покупку с использованием предоставленного токена Paddle и учётных данных Paddle в настройках приложения в дашборде Adapty. Если покупка действительна, история транзакций импортируется из Paddle в профиль Adapty с указанным customer_user_id. Если профиль с таким customer_user_id ранее не существовал — он будет создан.

Request body

customer_user_idstringrequired

Идентификатор пользователя в вашей системе

paddle_tokenstringrequired

Токен объекта Paddle, представляющего уникальную покупку. Может быть либо идентификатором транзакции (txn_...), либо идентификатором подписки (sub_...)

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

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

Example 
{
  "data": {
    "app_id": "14c3d623-2f3a-455a-aa86-ef83dff6913b",
    "profile_id": "3286abd3-48b0-4e9c-a5f6-ac0a006804a6",
    "customer_user_id": "Jane.doe@example.com",
    "total_revenue_usd": 0,
    "segment_hash": "8f45947bad31ab0c",
    "timestamp": 1736436751469,
    "custom_attributes": [
      {
        "key": "favourite_sport",
        "value": "yoga"
      }
    ],
    "access_levels": [],
    "subscriptions": [
      {
        "purchase_id": "5a7ab471-2299-45f7-ad69-1d395c1256e3",
        "store": "app_store",
        "store_product_id": "1year.premium",
        "store_base_plan_id": null,
        "store_transaction_id": "30002109551456",
        "store_original_transaction_id": "30002109551456",
        "purchased_at": "2022-10-12T09:42:50+00:00",
        "environment": "Production",
        "is_refund": false,
        "is_consumable": false
      }
    ],
    "non_subscriptions": []
  }
}

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

Schema
errorsarray of objectrequired
sourcestring

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

errorsarray of string

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

error_codestringrequired

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

status_codeintegerrequired

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

Example 
{
  "errors": [
    "No products found"
  ],
  "error_code": "no_products_found",
  "status_code": 400
}

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

Schema
errorsarray of objectrequired
sourcestring

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

errorsarray of string

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

error_codestringrequired

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

status_codeintegerrequired

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

Example 
{
  "errors": [
    "Invalid API key"
  ],
  "error_code": "unauthorized",
  "status_code": 401
}

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

Schema
errorsarray of objectrequired
sourcestring

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

errorsarray of string

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

error_codestringrequired

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

status_codeintegerrequired

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