OK.
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://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}'Валюта заказа. Используется трехбуквенное обозначение валюты согласно стандарту 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" } }
Телоapplication/jsonобязательный
Если передано значение true, то происходит отмена последнего платежа, сделанного по подписке. Данный параметр работает, только если статус платежа изменен на canceled.
Объект с информацией об отложенном сроке следующего списания.
Период платежного цикла, принимает значения day или month.
Перечисление"day""month"
ID партнера — идентификатор инфлюенсера или аффилированной сети. Можно найти в Личном кабинете в разделе Partner Network > Инфлюенсеры.
- https://api.xsolla.com/merchant/v2/projects/{project_id}/users/{user_id}/subscriptions/{subscription_id}
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/subscriptions/projects/{project_id}/users/{user_id}/subscriptions/{subscription_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
-u <username>:<password> \
'https://xsolla.redocly.app/_mock/ru/api/subscriptions/projects/{project_id}/users/{user_id}/subscriptions/{subscription_id}' \
-H 'Content-Type: application/json' \
-d '{
"status": "active"
}'Ответ
application/json
{ "charge_amount": 0.03, "currency": "USD", "date_create": "2018-09-21T16:54:59+03:00", "date_end": null, "date_last_charge": "2018-09-21T16:55:05+03:00", "date_next_charge": "2018-09-21T16:55:05+03:00", "id": 24953579, "plan": { "billing_retry": { … }, "charge": { … }, "description": null, "expiration": { … }, "external_id": "lowcost", "grace_period": { … }, "group_id": "newPlans", "id": 66001, "localized_name": null, "name": null, "project_id": 18404, "refund_period": null, "status": { … }, "tags": null, "trial": { … }, "type": "all" }, "product": null, "status": "active", "user": { "id": "jb1", "name": "J.Black" } }