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

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

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

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

Header parameters

Body

application/json

merchantId*string

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

Example: "622ebe94-9cc5-4776-8b5e-f24e73205048"

billingLinkId*string

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

Example: "7b79e356-d888-44d1-9af2-8b14aee085f9"

title*string

Имя подписки

Example: "Premium"

descriptionstring

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

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

spendInterval*integer

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

Example: "-1"

currency*string

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

Example: "USD"

amount*string

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

Example: "7.99"

webhookUrlstring

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

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

Response

200

Body

application/json

success*boolean

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

response*SubscriptionResponse (object)

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

Request

JavaScriptCurlPython

const response = await fetch('https://ocp.onchainpay.io/api-gateway/recurrents/create-subscription', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "merchantId": "622ebe94-9cc5-4776-8b5e-f24e73205048",
      "billingLinkId": "7b79e356-d888-44d1-9af2-8b14aee085f9",
      "title": "Premium",
      "spendInterval": "-1",
      "currency": "USD",
      "amount": "7.99"
    }),
});
const data = await response.json();

Response

200

{
  "success": false,
  "response": {
    "id": "af5bebaf-402a-42bf-97f8-7742fea9108d",
    "merchantId": "622ebe94-9cc5-4776-8b5e-f24e73205048",
    "billingLinkId": "7b79e356-d888-44d1-9af2-8b14aee085f9",
    "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-09-24T12:08:44.686Z",
    "updatedAt": "2024-09-24T12:08:44.686Z"
  }
}