Get user account url
Subscriptions API (2.0)
- Версия: 2.0
- Серверы:
https://api.xsolla.com/merchant/v2/
Этот справочник API описывает методы для управления подписками, купонами и акциями. Подробная информация о продукте Subscriptions приведена в руководстве по продукту и глоссарии.
Скачать описание OpenAPI
Языки
Серверы
Mock server
https://xsolla.redocly.app/_mock/ru/api/subscriptions/
- https://subscriptions.xsolla.com/api/v1/projects/{projectId}/subscriptions/user_account
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/subscriptions/api/v1/projects/{projectId}/subscriptions/user_account
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
'https://xsolla.redocly.app/_mock/ru/api/subscriptions/api/v1/projects/{projectId}/subscriptions/user_account' \
-H 'Content-Type: application/json' \
-d '{
"locale": "en",
"user_v1": "user123"
}'Ответ
application/json
{ "access_token": "<access_token>", "redirect_url": "https://subscriptions-user-account.xsolla.com/?token=<access_token>&projectId=<project_id>&merchantId=<merchant_id>&locale=<locale>" }
Запрос
Выводит список всех повторяющихся подписок.
Внимание
Этот метод API нельзя использовать при высокой нагрузке. Максимальная нагрузка составляет 20 запросов в минуту.
Этот метод API нельзя использовать при высокой нагрузке. Максимальная нагрузка составляет 20 запросов в минуту.
Внимание
Этот метод API не включает в себя path-параметр project_id, поэтому для авторизации вам необходимо использовать ключ API, который действует во всех проектах.
Безопасность
basicAuth
- https://api.xsolla.com/merchant/v2/merchants/{merchant_id}/subscriptions
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/subscriptions/merchants/{merchant_id}/subscriptions
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://xsolla.redocly.app/_mock/ru/api/subscriptions/merchants/{merchant_id}/subscriptions?offset=0&limit=0&user_id=string&project_id%5B%5D=0&plan_id%5B%5D=0&product_id%5B%5D=0&group_id%5B%5D=string&status%5B%5D=active&datetime_from=string&datetime_to=string'OK.
Валюта заказа. Используется трехбуквенное обозначение валюты согласно стандарту ISO 4217.
Дата создания подписки в формате YYYY-MM-DD’T’HH:MM:SS согласно стандарту ISO 8601.
Дата окончания подписки в формате YYYY-MM-DD’T’HH:MM:SS согласно стандарту ISO 8601.
Последняя дата списания платы за подписку в формате YYYY-MM-DD’T’HH:MM:SS согласно стандарту ISO 8601.
Следующая дата списания платы за подписку в формате YYYY-MM-DD’T’HH:MM:SS согласно стандарту ISO 8601.
Данные о попытках списания средств.
Объект с данными о рекуррентном списании.
Валюта заказа. Используется трехбуквенное обозначение валюты согласно стандарту ISO 4217.
Расчетный период.
Единица времени. Может принимать значения day, month или lifetime.
Перечисление"day""month""lifetime"
Список цен в различных валютах.
Валюта заказа. Используется трехбуквенное обозначение валюты согласно стандарту ISO 4217.
Описание плана. Значение состоит из пар "localization":"plan description".
Информация об истечении срока подписки.
Время периода отсрочки.
Название плана. Значение состоит из пар "localization":"plan name".
Период, в течение которого пользователь может вернуть средства, потраченные на план подписки (в днях).
Локализованные описания предметов.
Ответ
application/json
[ { "charge_amount": 0.03, "currency": "USD", "date_create": "2013-09-05T15:27:47+04:00", "date_end": "2014-02-06T11:32:48+04:00", "date_last_charge": null, "date_next_charge": null, "id": 45, "plan": { … }, "product": { … }, "status": "canceled", "user": { … } } ]
- https://api.xsolla.com/merchant/v2/projects/{project_id}/subscriptions/{subscription_id}
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/subscriptions/projects/{project_id}/subscriptions/{subscription_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://xsolla.redocly.app/_mock/ru/api/subscriptions/projects/{project_id}/subscriptions/{subscription_id}'OK.
Валюта заказа. Используется трехбуквенное обозначение валюты согласно стандарту ISO 4217.
Дата создания подписки в формате YYYY-MM-DD’T’HH:MM:SS согласно стандарту ISO 8601.
Дата окончания подписки в формате YYYY-MM-DD’T’HH:MM:SS согласно стандарту ISO 8601.
Последняя дата списания платы за подписку в формате YYYY-MM-DD’T’HH:MM:SS согласно стандарту ISO 8601.
Следующая дата списания платы за подписку в формате YYYY-MM-DD’T’HH:MM:SS согласно стандарту ISO 8601.
Данные о попытках списания средств.
Объект с данными о рекуррентном списании.
Валюта заказа. Используется трехбуквенное обозначение валюты согласно стандарту ISO 4217.
Расчетный период.
Единица времени. Может принимать значения day, month или lifetime.
Перечисление"day""month""lifetime"
Список цен в различных валютах.
Валюта заказа. Используется трехбуквенное обозначение валюты согласно стандарту ISO 4217.
Описание плана. Значение состоит из пар "localization":"plan description".
Информация об истечении срока подписки.
Время периода отсрочки.
Название плана. Значение состоит из пар "localization":"plan name".
Период, в течение которого пользователь может вернуть средства, потраченные на план подписки (в днях).
Локализованные описания предметов.
Ответ
application/json
{ "charge_amount": 0.03, "comment": "The subscription was not extended in due time", "currency": "USD", "date_create": "2018-09-21T16:54:59+03:00", "date_end": "2019-02-06T12:43:04+03:00", "date_last_charge": "2018-09-21T16:55:05+03:00", "date_next_charge": "2018-09-21T16:55:05+03:00", "id": 249579, "plan": { "external_id": "lowcost", "id": 601 }, "product": { "id": 123456 }, "status": "canceled", "user": { "id": "user1", "name": "John Smith" } }