Как изменить сумму списания по действующей подписке
Чтобы изменить сумму списания по действующей подписке, выполните HTTP-PATCH-запрос https://subscriptions.xsolla.com/api/v1/projects/{projectId}/subscriptions/{subscriptionId}/price.
После изменения суммы пользователю будет отправлено уведомление на email-адрес. Новая сумма списания начнет действовать со следующего платежного периода.
Чтобы изменить сумму списания для новых подписок, используйте метод Обновление плана. Новая сумма списания будет применяться только для новых подписок, все существующие подписки будут продолжать действовать на старых условиях.
Запрос к методу должен содержать заголовок Authorization: Basic <your_authorization_basic_key>, где <your_authorization_basic_key> — пара merchant_id:api_key, закодированная по стандарту Base64.
Значения параметров вы можете найти в Личном кабинете:
merchant_idуказан:- В разделе Настройки проекта > Вебхуки.
- Разделе Настройки компании > Компания.
- Aдресной строке браузера на любой странице Личного кабинета. URL-адрес имеет вид
https://publisher.xsolla.com/&lt;merchant ID>/<Publisher Account section>.
api_keyотображается в Личном кабинете только при создании и должен храниться на вашей стороне. Создать ключ можно в разделах:- Настройки компании > Ключи API;
- Настройки проекта > Ключи API.
В качестве path-параметров передайте:
| Параметр | Тип | Описание |
|---|---|---|
projectId | integer | Обязательный. ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта. |
subscriptionId | integer | Обязательный. ID подписки. |
| Параметр | Тип | Описание |
|---|---|---|
amount | float | Обязательный. Значение суммы списания по подписке. |
currency | string | Обязательный. Трехбуквенное обозначение валюты согласно стандарту ISO 4217. |
- curl
curl -X PATCH \
'https://subscriptions.xsolla.com/api/v1/projects/{project_id}/subscriptions/{subscription_id}/price' \
-H 'accept: application/json' \
-H 'Authorization: Basic'
{
"amount": 4.99,
"currency": "USD"
}
Примеры ответов:
200— Сумма списания успешно изменена.400— Подписка не активна.404— Подписка не найдена.
Нашли опечатку или ошибку в тексте? Выделите ее и нажмите Ctrl+Enter.
