Редагування плану та додавання нової версіі

POST /ecom/jws/scheduled_payments/plan/update_v1

Параметр	Опис	Формат даних	Обовʼязковість	Приклад
merchantId	id мерчанта в ecom	uuid(36)	так	137d9304-0368-11ed-b939-0242ac120002
planId	Унікальний ідентифікатор створеної підписки	uuid	так
Параметри плану, які редагуються
name	Назва підписки, що відображається мерчанту та/або користувачу	string (150)	ні	Premium subscription
description	Опис підписки	string (255)	ні	Monthly premium access
Параметри нової версіі
rules	масив з правилами	array	так, якщо необхідно додати нову версію
rules.paymentNumberFrom	початковий номер платіжа з якого почина діяти дане правило	int	так	1
rules.paymentNumberTo	останній номер платіжа для якого ще працює правило	int	так	1
rules.intervalValue	значення через скільки буде наступний платіж	int	так	12
rules.intervalUnit	значення через скільки буде наступний платіж	string	так	DAY, WEEK, MONTH
rules.coinAmount	Сума списання за один білінг-інтервал	long	так	2000
rules.currency	Валюта підписки	string	так	980
appliesDateTimeFrom	зміна версії застосовується з	TIMESTAMPZ	ні, якщо параметр не передається то зміни застосовуються одразу appliesDateTimeFrom нової версіі = appliesDateTimeTo старої версіі appliesDateTimeFrom нової версіі не може бути більшим за appliesDateTimeTo старої версіі якщо appliesDateTimeFrom нової версіі мерньший чим appliesDateTimeTo старої версіі, то відбудеться оновлення appliesDateTimeTo старої версії датою appliesDateTimeFrom новох версіі	2026-02-26 11:23:45.12+02:00
appliesDateTimeTo	версія застосовується до.. після цієї дати видаляться всі заплановані платежі по цьому плану	TIMESTAMPZ	ні, якщо параметр не передається то позамовчуванню на 1 рік вперед	2026-02-26 11:23:45.12+02:00

Вихідні параметри:

Параметр	Опис	Формат даних	Приклад
planId	Унікальний ідентифікатор створеної підписки	uuid
versionId	Id версіі	int	1
merchantId	Ідентифікатор мерчанта	uuid
name	Назва підписки	string	Premium subscription
description	Опис підписки	string	Monthly premium access
rules.paymentNumberFrom	початковий номер платіжа з якого почина діяти дане правило	integer	1
rules.paymentNumberTo	останній номер платіжа для якого ще працює правило	integer	1
rules.intervalValue	Значення білінг-інтервалу	integer	1
rules.intervalUnit	Одиниця білінг-інтервалу	string	MONTH
rules.coinAmount	сума	long	10
rules.currency	валюта	string	980
appliesDateTimeFrom	зміна застосовується з	TIMESTAMPZ	2026-02-26 11:23:45.12+02:00
appliesDateTimeTo	зміна застосовується до	TIMESTAMPZ	2026-02-26 11:23:45.12+02:00
createdAt	Дата та час створення плану	TIMESTAMPZ	2026-02-26 11:23:45.12+02:00
updatedAt	Дата та час останнього оновлення плану	TIMESTAMPZ	2026-02-26 11:23:45.12+02:00

Приклад запиту редагування параметрів плану

{
   "merchantId":"{{merchantId}}",
   "planId":"{{planId}}",
   "name":"Premium",
   "categorySubcategoryIndicator":"C103",
   "description":"Installment plan123543521"
}

Приклад відповіді

{
    "planId": "a9562240-10ca-42d7-8d90-bbd1ace3dc5a",
    "merchantId": "137d9304-0368-11ed-b939-0242ac120002",
    "name": "Premium",
    "description": "Installment plan123543521",
    "createdAt": "2026-07-09 17:12:00.14+03:00",
    "updatedAt": "2026-07-10 11:36:39.35+03:00"
}

Приклад запиту редагування параметрів плану та додавання нової версіі

{
   "merchantId":"{{merchantId}}",
   "planId":"{{planId}}",
   "name":"Premium",
   "categorySubcategoryIndicator":"C103",
   "description":"Installment plan123543521",
   "appliesDateTimeFrom":"2026-08-23 12:46:00.52+03:00",
   "appliesDateTimeTo":"2026-09-23 12:46:00.52+03:00",
   "rules":[
      {
         "paymentNumberFrom":1,
         "paymentNumberTo":3,
         "intervalValue":1,
         "intervalUnit":"DAY",
         "coinAmount":205,
         "currency":"980"
      },
      {
         "paymentNumberFrom":4,
         "paymentNumberTo":6,
         "intervalValue":1,
         "intervalUnit":"MONTH",
         "coinAmount":8000,
         "currency":"980"
      }
   ]
}

Приклад відповіді

{
    "planId": "a9562240-10ca-42d7-8d90-bbd1ace3dc5a",
    "versionId": 2,
    "merchantId": "137d9304-0368-11ed-b939-0242ac120002",
    "name": "Premium",
    "description": "Installment plan123543521",
    "rules": [
        {
            "paymentNumberFrom": 1,
            "paymentNumberTo": 3,
            "intervalValue": 1,
            "intervalUnit": "DAY",
            "coinAmount": 205,
            "currency": "980"
        },
        {
            "paymentNumberFrom": 4,
            "paymentNumberTo": 6,
            "intervalValue": 1,
            "intervalUnit": "MONTH",
            "coinAmount": 8000,
            "currency": "980"
        }
    ],
    "appliesDateTimeFrom": "2026-08-23 12:46:00.52+03:00",
    "appliesDateTimeTo": "2026-09-23 12:46:00.52+03:00",
    "createdAt": "2026-07-09 17:12:00.14+03:00",
    "updatedAt": "2026-07-10 11:33:08.87+03:00"
}

Приклад запиту додавання нової версіі

{
   "merchantId":"{{merchantId}}",
   "planId":"{{planId}}",
   "appliesDateTimeFrom":"2026-08-24 12:46:00.52+03:00",
   "appliesDateTimeTo":"2026-09-23 12:46:00.52+03:00",
   "rules":[
      {
         "paymentNumberFrom":1,
         "paymentNumberTo":3,
         "intervalValue":1,
         "intervalUnit":"DAY",
         "coinAmount":205,
         "currency":"980"
      },
      {
         "paymentNumberFrom":4,
         "paymentNumberTo":6,
         "intervalValue":1,
         "intervalUnit":"MONTH",
         "coinAmount":8000,
         "currency":"980"
      }
   ]
}

Приклад відповіді

{
    "planId": "a9562240-10ca-42d7-8d90-bbd1ace3dc5a",
    "versionId": 3,
    "merchantId": "137d9304-0368-11ed-b939-0242ac120002",
    "name": "Premium",
    "description": "Installment plan123543521",
    "rules": [
        {
            "paymentNumberFrom": 1,
            "paymentNumberTo": 3,
            "intervalValue": 1,
            "intervalUnit": "DAY",
            "coinAmount": 205,
            "currency": "980"
        },
        {
            "paymentNumberFrom": 4,
            "paymentNumberTo": 6,
            "intervalValue": 1,
            "intervalUnit": "MONTH",
            "coinAmount": 8000,
            "currency": "980"
        }
    ],
    "appliesDateTimeFrom": "2026-08-24 12:46:00.52+03:00",
    "appliesDateTimeTo": "2026-09-23 12:46:00.52+03:00",
    "createdAt": "2026-07-09 17:12:00.14+03:00",
    "updatedAt": "2026-07-10 11:40:19.68+03:00"
}