Метод для внесення змін по інвойсу з типом SUBSCRIBE (рекурентні платежі)

URI

POST api/invoicer/subscriptions/update

Запит:

Ключ

Опис

Тип

Обов'язковість

Приклад

params





sessionId

id сессії клієнта

string, uuid

так

"00684a7f-3d5c-43f4-b4d1-ea994226be9c"

id

id інвойсу

string, uuid

так

"6e391161-94ff-41a3-bd22-c6d77509bff6"

data





interval

інтервал проведення рекурентного платежу

integer

ні

1

expiresAt

термін завершення рекурентних оплат

integer

ні

1535749199999

Приклад:

{
    "params": {
        "sessionId": "613f7045-03a2-4bbb-8ff8-e2202e71d41f",
        "invoiceId": "a911eea9-f791-4e9a-bcaf-a422585ec098"
    },
    "data": {
        "interval": 1,
        "expiresAt": 1635749199999
    }
}

Відповідь:

Ключ

Опис

Тип

Приклад

status

Статус. 0 - помилка, 1 - успіх

integer

1

data




invoiceid

id інвойсу

string, uuid

"a911eea9-f791-4e9a-bcaf-a422585ec098"

amount

сума рекурентного платежу

integer

100

commission

комісія платежу

integer

500

interval

інтервал проведення рекурентного платежу

integer

1

expiresAt

термін завершення рекурентних оплат

integer

"2021-11-01T06:46:39.999Z"

plannedPaidAt

дата оплати

string

"2018-09-07T12:41:05.000Z"

status

статус підписки

string

"ACTIVE"

Приклад:

{
    "status": 1,
    "data": {
        "invoiceId": "a911eea9-f791-4e9a-bcaf-a422585ec098",
        "amount": 1000,
        "commission": 500,
        "interval": 1,
        "expiresAt": "2021-11-01T06:46:39.999Z",
        "plannedPaidAt": "2018-09-07T12:41:05.000Z",
        "status": "ACTIVE"
    }
}