Update invoice data with SUBSCRIBE type

Method for making changes to the invoice with SUBSCRIBE type (recurrent payments)

URI

POST api/invoicer/subscriptions/update

Request:

Key

Description

Type

Mandatory

Example

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:

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

Reply:

Key

Description

Type

Example

Key

Description

Type

Example

status

Status. 0 - error, 1 - success

integer

1

data

 





invoiceid

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:

1 2 3 4 5 6 7 8 9 10 11 12 { "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" } }