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

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

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

POSThttps://ocp.onchainpay.io/api-gateway/recurrents/create-subscription

Header parameters

Body

merchantId*string

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

billingLinkId*string

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

title*string

Имя подписки

descriptionstring

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

spendInterval*integer

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

currency*string

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

amount*string

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

webhookUrlstring

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

Response

Body

success*boolean

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

response*SubscriptionResponse (object)

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

Request

const response = await fetch('https://ocp.onchainpay.io/api-gateway/recurrents/create-subscription', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "merchantId": "da72896a-2f63-40d8-840d-d1a060d8c1e9",
      "billingLinkId": "e942f357-005f-44ea-9e18-86ec3f626f11",
      "title": "Premium",
      "spendInterval": "-1",
      "currency": "USD",
      "amount": "7.99"
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "response": {
    "id": "7fb34875-9a8f-4f32-bdd3-9378a3526421",
    "merchantId": "da72896a-2f63-40d8-840d-d1a060d8c1e9",
    "billingLinkId": "e942f357-005f-44ea-9e18-86ec3f626f11",
    "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-05-07T11:27:25.619Z",
    "updatedAt": "2024-05-07T11:27:25.619Z"
  }
}

PreviousОтключение платежной связки NextПолучение подписки

Last updated 8 months ago

const response = await fetch('https://ocp.onchainpay.io/api-gateway/recurrents/create-subscription', { method: 'POST', headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "merchantId": "da72896a-2f63-40d8-840d-d1a060d8c1e9", "billingLinkId": "e942f357-005f-44ea-9e18-86ec3f626f11", "title": "Premium", "spendInterval": "-1", "currency": "USD", "amount": "7.99" }), }); const data = await response.json();

{ "success": false, "response": { "id": "7fb34875-9a8f-4f32-bdd3-9378a3526421", "merchantId": "da72896a-2f63-40d8-840d-d1a060d8c1e9", "billingLinkId": "e942f357-005f-44ea-9e18-86ec3f626f11", "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-05-07T11:27:25.619Z", "updatedAt": "2024-05-07T11:27:25.619Z" } }