Endpoint-ы
| HTTP метод | URL | Описание |
|---|---|---|
GET |
/payment/v2/subscription |
Возвращает отфильтрованный список с пагинацией. |
GET |
/payment/v2/subscription/{subscriptionId} |
Возвращает подписку по идентификатору. |
Для списка доступны query-параметры page (по умолчанию 0), size (по умолчанию 10), subscriptionId, status и periodType. Значения periodType: WEEK/7, MONTH/30, YEAR/365.
Модель ответа
Для одиночного запроса data содержит подписку. Для списка возвращаются data.items, page, size и totalSize.
| Поле | Тип | Описание |
|---|---|---|
id |
long |
Идентификатор подписки. |
paymentPlanCode |
string |
Код плана. |
externalCustomerId |
string |
Идентификатор клиента мерчанта. |
merchantId |
long |
Идентификатор мерчанта. |
buyerId |
long |
Идентификатор покупателя. |
cardUserKey |
string |
Ключ пользователя сохранённой карты. |
cardToken |
string |
Токен сохранённой карты. |
price / nextPrice |
decimal |
Текущая и следующая сумма периода. |
nextPriceStartPeriod |
integer |
Период начала следующей суммы. |
variablePayment |
boolean |
Признак переменной суммы. |
variablePaymentTriggerType |
string |
SCHEDULED или EXTERNAL. |
periodType |
string |
WEEK, MONTH или YEAR. |
description |
string |
Описание подписки. |
noChargeDayCount |
integer |
Количество бесплатных дней. |
nextPaymentDate |
date-time |
Время следующего списания. |
status |
string |
Статус подписки. |
paidCount / currentPeriod |
integer |
Количество оплат и текущий период. |