Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Метод для внесення змін по інвойсу з типом SUBSCRIBE (рекурентні платежіMethod for making changes to the invoice with SUBSCRIBE type (recurrent payments)

Tip

URI

POST api/invoicer/subscriptions/update

...

Request:

Ключ

Key

Опис

Description

Тип

Type

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

Mandatory

Приклад

Example

params





sessionId

client session id

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

string, uuid

так

yes

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

id

invoice id

інвойсу

string, uuid

так

yes

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

data



interval

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

recurrent payment interval

integer

ні

no

1

expiresAt

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

deadline for completion of recurrent payments

integer

ні

no

1535749199999

...

Example:

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

ВідповідьReply:

Ключ

Key

Опис

Description

Тип

Type

Приклад

Example

status

Статус

Status. 0 -

помилка

error, 1 -

успіх

success

integer

1

data



invoiceid

id інвойсу

Invoice ID

string, uuid

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

amount

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

the amount of the recurrent payment

integer

100

commission

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

payment commission

integer

500

interval

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

recurrent payment interval

integer

1

expiresAt

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

deadline for completion of recurrent payments

integer

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

plannedPaidAt

дата оплати

date of payment

string

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

status

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

subscription status

string

"ACTIVE"

...

Example:

Code Block
{
    "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"
    }
}

...