Создание подписки
Метод позволяет подключить подписку
Header parameters
x-api-public-keystringOptional
Публичный API-ключ
x-api-signaturestringOptional
Подпись тела запроса приватным API-ключем
Content-typestringOptionalExample:
Тип тела запроса
application/json
Body
Тело запроса создания подписки
merchantIdstringRequiredExample:
Идентификатор мерчанта в системе
86f1f78d-77c6-4bb1-b67c-8389218ce646
billingLinkIdstringRequiredExample:
Идентификатор платежной связки (с привязанного адреса будут списываться монеты)
9b0838e7-54ca-4da7-9634-d497a47f9381
titlestringRequiredExample:
Имя подписки
Premium
descriptionstringOptionalExample:
Описание подписки
Premium subscription. With premium subscription u can use premium functions
spendIntervalintegerRequiredExample:
Период списаний в минутах. Для удобства можно указывать: -1 - ежедневное списание; -2 - еженедельное списание; -3 - ежемесячное списание;
-1
currencystringRequiredExample:
Валюта списания. Можно указать фиатную валюту или любую другую, сумма будет автоматически пересчтана в валюту платежной связки
USD
amountstringRequiredExample:
Сумма списания в указанной валюте
7.99
webhookUrlstringOptionalExample:
URL для уведомления о списаниях по подписке
https://merchant.domain/webhooks/subscription
Responses
200Success
application/json
post
POST /api-gateway/recurrents/create-subscription HTTP/1.1
Host: app.apollopayment.io
Content-Type: application/json
Accept: */*
Content-Length: 333
{
"merchantId": "86f1f78d-77c6-4bb1-b67c-8389218ce646",
"billingLinkId": "9b0838e7-54ca-4da7-9634-d497a47f9381",
"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"
}
200Success
{
"success": true,
"response": {
"id": "acf68fc3-a964-42a2-83b9-55756acdd967",
"merchantId": "86f1f78d-77c6-4bb1-b67c-8389218ce646",
"billingLinkId": "9b0838e7-54ca-4da7-9634-d497a47f9381",
"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": "2025-06-09T13:18:29.435Z",
"updatedAt": "2025-06-09T13:18:29.435Z"
}
}
Last updated