Создание подписки
Метод позволяет подключить подписку
Header parameters
x-api-public-keystringOptional
Публичный API-ключ
x-api-signaturestringOptional
Подпись тела запроса приватным API-ключем
Content-typestringOptionalExample:
Тип тела запроса
application/json
Body
Тело запроса создания подписки
merchantIdstringRequiredExample:
Идентификатор мерчанта в системе
3ce560cc-4d42-4543-b9ef-8cc35c00638c
billingLinkIdstringRequiredExample:
Идентификатор платежной связки (с привязанного адреса будут списываться монеты)
6a42622f-4968-47e2-a24d-5f5f1dc1acd6
titlestringRequiredExample:
Имя подписки
Premium
descriptionstringOptionalExample:
Описание подписки
Premium subscription. With premium subscription u can use premium functions
spendIntervalintegerRequiredExample:
Период списаний в минутах. Для удобства можно указывать: -1 - ежедневное списание; -2 - еженедельное списание; -3 - ежемесячное списание;
-1
currencystringRequiredExample:
Валюта списания. Можно указать фиатную валюту или любую другую, сумма будет автоматически пересчтана в валюту платежной связки
USD
amountstringRequiredExample:
Сумма списания в указанной валюте
7.99
webhookUrlstringOptionalExample:
URL для уведомления о списаниях по подписке
https://merchant.domain/webhooks/subscription
Responses
200Success
application/json
post
POST /api-gateway/recurrents/create-subscription HTTP/1.1
Host: ocp.onchainpay.io
Content-Type: application/json
Accept: */*
Content-Length: 333
{
"merchantId": "3ce560cc-4d42-4543-b9ef-8cc35c00638c",
"billingLinkId": "6a42622f-4968-47e2-a24d-5f5f1dc1acd6",
"title": "Premium",
"description": "Premium subscription. With premium subscription u can use premium functions",
"spendInterval": "-1",
"currency": "USD",
"amount": "7.99",
"webhookUrl": "https://merchant.domain/webhooks/subscription"
}
200Success
{
"success": true,
"response": {
"id": "f7048e9c-798e-4d9a-bab6-a1885efc8283",
"merchantId": "3ce560cc-4d42-4543-b9ef-8cc35c00638c",
"billingLinkId": "6a42622f-4968-47e2-a24d-5f5f1dc1acd6",
"title": "Premium",
"description": "Premium subscription. With premium subscription u can use premium functions",
"spendInterval": "-1",
"status": "PENDING",
"message": null,
"currency": "USD",
"amount": "7.99",
"webhookUrl": "https://merchant.domain/webhooks/subscription",
"createdAt": "2025-06-09T13:18:11.532Z",
"updatedAt": "2025-06-09T13:18:11.532Z"
}
}
Last updated