Створити план та версію

POST {{url}}/ecom/jws/scheduled_payments/plan/create_v1

План — це «шаблон» вашої підписки. Наприклад, «Місячна підписка на преміум-сервіс» або «Щотижнева оплата за обслуговування»

Версія — це конкретні умови списання: скільки, як часто, і протягом якого періоду.

Правила:

• ✅ Активна версія може бути тільки одна у кожний момент часу

• ❌ Суму та інтервал не можна змінити після створення — потрібна нова версія

• ✅ Дати дії можна коригувати

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

Параметр	Опис	Формат даних	Обовʼязковість	Приклад
merchantId	id мерчанта в ecom	uuid(36)	так	137d9304-0368-11ed-b939-0242ac120002
name	Назва підписки	string (150)	так	Premium subscription
categorySubcategoryIndicator	Категрія та саб ктегорія	enum	так	C103
description	Додатковий опис підписки	string (255)	ні	Monthly premium access
rules	Масив з правилами	array	так
rules.paymentNumberFrom	Початковий номер платіжа з якого почина діяти дане правило	int	так	1
rules.paymentNumberTo	Останній номер платіжа для якого ще працює правило	int	так	1
rules.intervalValue	Значення через скільки буде наступний платіж	int	так	14
rules.intervalUnit	Значення через скільки буде наступний платіж	string	так	DAY, WEEK, MONTH
rules.coinAmount	Сума списання за один білінг-інтервал	long	так	2000
rules.currency	Валюта підписки	string	так	980

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

Параметр	Опис	Формат даних	Приклад
planId	Унікальний ідентифікатор створеної підписки	string
versionId	Id версіі	int	1
merchantId	Ідентифікатор мерчанта	uuid
name	Назва підписки	string	Premium subscription
description	Опис підписки	string	Monthly premium access
status	Поточний статус підписки	string	ACTIVE
rules	масив з правилами	array
rules.paymentNumberFrom	початковий номер платіжа з якого почина діяти дане правило	int	1
rules.paymentNumberTo	останній номер платіжа для якого ще працює правило	int	1
rules.intervalValue	значення через скільки буде наступний платіж	int	14
rules.intervalUnit	значення через скільки буде наступний платіж	string	DAY, WEEK, MONTH
rules.coinAmount	Сума списання за один білінг-інтервал	long	2000
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}}",
   "name":"Premium subscription",
   "categorySubcategoryIndicator":"C103",
   "description":"Monthly premium access",
   "appliesDateTimeFrom":"2026-07-13 13:04:36.467 +0200",
   "appliesDateTimeTo":"2026-07-20 13:04:36.467 +0200",
   "rules":[
      {
         "paymentNumberFrom":1,
         "paymentNumberTo":5,
         "intervalValue":1,
         "intervalUnit":"DAY",
         "coinAmount":100,
         "currency":"980"
      },
      {
         "paymentNumberFrom":6,
         "paymentNumberTo":10,
         "intervalValue":1,
         "intervalUnit":"MONTH",
         "coinAmount":8000,
         "currency":"980"
      }
   ]
}

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

{
    "planId": "a9562240-10ca-42d7-8d90-bbd1ace3dc5a",
    "versionId": 1,
    "merchantId": "137d9304-0368-11ed-b939-0242ac120002",
    "name": "Premium subscription",
    "description": "Monthly premium access",
    "status": "ACTIVE",
    "rules": [
        {
            "paymentNumberFrom": 1,
            "paymentNumberTo": 5,
            "intervalValue": 1,
            "intervalUnit": "DAY",
            "coinAmount": 100,
            "currency": "980"
        },
        {
            "paymentNumberFrom": 6,
            "paymentNumberTo": 10,
            "intervalValue": 1,
            "intervalUnit": "MONTH",
            "coinAmount": 8000,
            "currency": "980"
        }
    ],
    "appliesDateTimeFrom": "2026-07-09 17:12:00.14+03:00",
    "createdAt": "2026-07-09 17:12:00.14+03:00",
    "updatedAt": "2026-07-09 17:12:00.14+03:00"
}