Перейти к содержимому
/
Изменение подписки

Subscriptions API (2.0)

Введение

  • Версия: 2.0
  • Серверы: https://api.xsolla.com/merchant/v2/

Этот справочник API описывает методы для управления подписками, купонами и акциями. Подробная информация о продукте Subscriptions приведена в руководстве по продукту и глоссарии.

Скачать описание OpenAPI
index.json
index.yaml
Языки
Серверы
Mock server
https://xsolla.redocly.app/_mock/ru/api/subscriptions/

Токен

Операции

Планы

Операции

Продукты

Операции

Subscription management

Операции

Информация о подписке

Запрос

Информация о конкретной подписке по ID.

Безопасность
basicAuth
Путь
project_idintegerобязательный

ID проекта.

subscription_idintegerобязательный

ID подписки.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ru/api/subscriptions/projects/{project_id}/subscriptions/{subscription_id}'

Ответы

OK.

Телоapplication/json
charge_amountnumber(float)

Сумма рекуррентного списания.

commentstring

Причина изменения статуса подписки

currencystring

Валюта заказа. Используется трехбуквенное обозначение валюты согласно стандарту ISO 4217.

date_createstring(datetime)

Дата создания подписки в формате YYYY-MM-DD’T’HH:MM:SS согласно стандарту ISO 8601.

date_endstring(datetime)

Дата окончания подписки в формате YYYY-MM-DD’T’HH:MM:SS согласно стандарту ISO 8601.

date_last_chargestring or null(datetime)

Последняя дата списания платы за подписку в формате YYYY-MM-DD’T’HH:MM:SS согласно стандарту ISO 8601.

date_next_chargestring or null(datetime)

Следующая дата списания платы за подписку в формате YYYY-MM-DD’T’HH:MM:SS согласно стандарту ISO 8601.

idinteger

ID подписки

planobject
productobject or null
statusstring

Статус

Перечисление"new""active""canceled""non_renewing""freeze"
userobject
Ответ
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"
  }
}

Изменение подписки

Запрос

Изменение рекуррентной подписки. Можно изменить статус подписки (active, canceled или non_renewing) и отложить дату следующего списания для данной подписки.

Безопасность
basicAuth
Путь
project_idintegerобязательный

ID проекта.

user_idstringобязательный

ID пользователя.

subscription_idintegerобязательный

ID подписки.

Телоapplication/jsonобязательный
cancel_subscription_paymentboolean

Если передано значение true, то происходит отмена последнего платежа, сделанного по подписке. Данный параметр работает, только если статус платежа изменен на canceled.

statusstring

Статус.

Перечисление"active""canceled""non_renewing"
timeshiftobject

Объект с информацией об отложенном сроке следующего списания.

xsolla_networkobject
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"
  }'

Ответы

OK.

Телоapplication/json
Ответ
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"
  }
}

Платежи

Операции

Акции

Операции

Купоны

Операции

Subscription management

Операции