Create a subscription

The method allows you to connect a subscription

Create a subscription

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

Header parameters

Body

application/json

merchantId*string

Merchant ID in the system

Example: "7d84b681-d1ea-431e-b479-4834577a33ae"

billingLinkId*string

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

Example: "ca1763a5-1ff3-42c1-9673-a3cffe66cd89"

title*string

Subscription name

Example: "Premium"

descriptionstring

Subscription Description

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

spendInterval*integer

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

Example: "-1"

currency*string

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"

amount*string

Payment amount in the specified currency

Example: "7.99"

webhookUrlstring

Subscription charge notification URL

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

Response

200

Body

application/json

success*boolean

Request success indicator

response*SubscriptionResponse (object)

Subscription response body

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": "7d84b681-d1ea-431e-b479-4834577a33ae",
      "billingLinkId": "ca1763a5-1ff3-42c1-9673-a3cffe66cd89",
      "title": "Premium",
      "spendInterval": "-1",
      "currency": "USD",
      "amount": "7.99"
    }),
});
const data = await response.json();

Response

200

{
  "success": false,
  "response": {
    "id": "3d3a9f0c-b86c-46c8-b01a-ce913eb3a0a0",
    "merchantId": "7d84b681-d1ea-431e-b479-4834577a33ae",
    "billingLinkId": "ca1763a5-1ff3-42c1-9673-a3cffe66cd89",
    "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-11-07T12:41:09.851Z",
    "updatedAt": "2024-11-07T12:41:09.851Z"
  }
}