POST /api/v2/server-side-api/purchase/paddle/token/validate/

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

Валидирует покупку с использованием предоставленного токена 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

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

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 продукта в сторе

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

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

billing_issue_detected_atstring

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

is_in_grace_periodboolean

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

cancellation_reasonstring

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

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-код статуса

Try it

Authorization

Body

curl --request POST \
  --url 'https://api.adapty.io/api/v2/server-side-api/purchase/paddle/token/validate/' \
  --header 'Authorization: Api-Key YOUR_SECRET_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "customer_user_id": "<YOUR_CUSTOMER_USER_ID>",
    "paddle_token": "live_7d279f61a3339fed520f7cd8c08"
  }'

const response = await fetch('https://api.adapty.io/api/v2/server-side-api/purchase/paddle/token/validate/', {
  method: 'POST',
  headers: {
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "customer_user_id": "<YOUR_CUSTOMER_USER_ID>",
    "paddle_token": "live_7d279f61a3339fed520f7cd8c08"
  }),
});
const data = await response.json();

import requests

response = requests.post('https://api.adapty.io/api/v2/server-side-api/purchase/paddle/token/validate/', headers={
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
}, json={
      "customer_user_id": "<YOUR_CUSTOMER_USER_ID>",
      "paddle_token": "live_7d279f61a3339fed520f7cd8c08"
    })
data = response.json()