Create a subscription

The method allows you to connect a subscription

Create a subscription

post

/api-gateway/recurrents/create-subscription

Header parameters

x-api-public-keystring

Public API-key

x-api-signaturestring

Signing the request body with a private API-key

Content-typestring

Request content type

Example: application/json

Body

merchantIdstringrequired

Merchant ID in the system

Example: 41fe615a-96dc-42c2-9629-196383411cd4

billingLinkIdstringrequired

Payment link identifier (coins will be debited from the linked address)

Example: 60b5c367-1b93-448a-b08a-16da458102b5

titlestringrequired

Subscription name

Example: Premium

descriptionstring

Subscription Description

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

spendIntervalintegerrequired

Write-off period in minutes. For convenience, you can specify: -1 - daily write-off; -2 - weekly write-off; -3 - monthly write-off;

Example: -1

currencystringrequired

Payment currency. You can specify a fiat currency or any other, the amount will be automatically converted to the currency of the payment link

Example: USD

amountstringrequired

Payment amount in the specified currency

Example: 7.99

webhookUrlstring

Subscription charge notification URL

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://ocp.onchainpay.io/api-gateway/recurrents/create-subscription' \
  --header 'Content-Type: application/json' \
  --data '{"merchantId":"41fe615a-96dc-42c2-9629-196383411cd4","billingLinkId":"60b5c367-1b93-448a-b08a-16da458102b5","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": "671fafbb-8795-4d0b-8614-06d5a6190f4e",
    "merchantId": "41fe615a-96dc-42c2-9629-196383411cd4",
    "billingLinkId": "60b5c367-1b93-448a-b08a-16da458102b5",
    "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",
    "createdAt": "2024-12-26T08:21:33.222Z",
    "updatedAt": "2024-12-26T08:21:33.222Z",
    "status": "PENDING",
    "message": null
  }
}