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

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

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

POSThttps://ocp.payonchain.org/api-gateway/recurrents/create-subscription

Header parameters

Body

application/json

merchantId*string

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

billingLinkId*string

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

title*string

Имя подписки

descriptionstring

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

spendInterval*integer

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

currency*string

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

amount*string

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

webhookUrlstring

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

Response

200

Body

application/json

success*boolean

Признак успешности запроса

response*SubscriptionResponse (object)

Тело ответа подписки

Request

JavaScriptCurl

const response = await fetch('https://ocp.payonchain.org/api-gateway/recurrents/create-subscription', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "merchantId": "672c1e2d-354f-49a1-8a5b-75af87e92f0a",
      "billingLinkId": "2bfbdf44-fb5b-4e75-9962-f28c0594e483",
      "title": "Premium",
      "spendInterval": "-1",
      "currency": "USD",
      "amount": "7.99"
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "response": {
    "id": "be1179ff-36a5-4fee-8e5a-7e11a93bb99f",
    "merchantId": "672c1e2d-354f-49a1-8a5b-75af87e92f0a",
    "billingLinkId": "2bfbdf44-fb5b-4e75-9962-f28c0594e483",
    "title": "Premium",
    "description": "Premium subscription. With premium subscription u can use premium functions",
    "spendInterval": "-1",
    "status": "PENDING",
    "currency": "USD",
    "amount": "7.99",
    "webhookUrl": "https://merchant.domain/webhooks/subscription",
    "createdAt": "2024-04-15T10:50:48.518Z",
    "updatedAt": "2024-04-15T10:50:48.518Z"
  }
}