Создание подписки

Метод позволяет подключить подписку

Создание подписки

post

Header parameters

x-api-public-keystringoptional

Публичный API-ключ

x-api-signaturestringoptional

Подпись тела запроса приватным API-ключем

Content-typestringoptional

Тип тела запроса

Example: application/json

Body

Тело запроса создания подписки

merchantIdstringrequired

Идентификатор мерчанта в системе

Example: 2612ad7b-ed3d-45e4-aab2-6a13e2ecd0e0

billingLinkIdstringrequired

Идентификатор платежной связки (с привязанного адреса будут списываться монеты)

Example: e34d0746-b972-4b07-a9be-931f1578e898

titlestringrequired

Имя подписки

Example: Premium

descriptionstringoptional

Описание подписки

Example: Premium subscription. With premium subscription u can use premium functions

spendIntervalintegerrequired

Период списаний в минутах. Для удобства можно указывать: -1 - ежедневное списание; -2 - еженедельное списание; -3 - ежемесячное списание;

Example: -1

currencystringrequired

Валюта списания. Можно указать фиатную валюту или любую другую, сумма будет автоматически пересчтана в валюту платежной связки

Example: USD

amountstringrequired

Сумма списания в указанной валюте

Example: 7.99

webhookUrlstringoptional

URL для уведомления о списаниях по подписке

Example: https://merchant.domain/webhooks/subscription

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://ocp.onchainpay.io/api-gateway/recurrents/create-subscription' \
  --header 'Content-Type: application/json' \
  --data '{
    "merchantId": "2612ad7b-ed3d-45e4-aab2-6a13e2ecd0e0",
    "billingLinkId": "e34d0746-b972-4b07-a9be-931f1578e898",
    "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"
  }'

200

200

{
  "success": true,
  "response": {
    "id": "31d5766b-ddfa-4311-831c-7c90fd16f3d2",
    "merchantId": "2612ad7b-ed3d-45e4-aab2-6a13e2ecd0e0",
    "billingLinkId": "e34d0746-b972-4b07-a9be-931f1578e898",
    "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": "2024-12-25T14:35:23.174Z",
    "updatedAt": "2024-12-25T14:35:23.174Z"
  }
}