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

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

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

post

/api-gateway/recurrents/create-subscription

Header parameters

x-api-public-keystring

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

x-api-signaturestring

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

Content-typestring

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

Example: application/json

Body

merchantIdstringrequired

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

Example: deefcd05-aa9d-4e9c-99ef-05afd371ce8f

billingLinkIdstringrequired

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

Example: 42a8b646-c7e3-49fc-b536-ae4c25bdea79

titlestringrequired

Имя подписки

Example: Premium

descriptionstring

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

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

spendIntervalintegerrequired

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

Example: -1

currencystringrequired

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

Example: USD

amountstringrequired

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

Example: 7.99

webhookUrlstring

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

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://app.apollopayment.io/api-gateway/recurrents/create-subscription' \
  --header 'Content-Type: application/json' \
  --data '{
    "merchantId": "deefcd05-aa9d-4e9c-99ef-05afd371ce8f",
    "billingLinkId": "42a8b646-c7e3-49fc-b536-ae4c25bdea79",
    "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": "57d9b658-8c89-4fe9-ad8a-4d7d1535623f",
    "merchantId": "deefcd05-aa9d-4e9c-99ef-05afd371ce8f",
    "billingLinkId": "42a8b646-c7e3-49fc-b536-ae4c25bdea79",
    "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-26T08:21:53.368Z",
    "updatedAt": "2024-12-26T08:21:53.368Z"
  }
}