Getting a subscription

The method allows you to get information about the subscription

Getting a subscription

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

Header parameters

Body

application/json

id*string

Subscription ID

Example: "89f8090b-364b-4d1b-b3f3-6f39417ef90a"

merchantId*string

Merchant ID

Example: "21491261-1a2c-4895-9628-966baea0356d"

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/get-subscription', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "89f8090b-364b-4d1b-b3f3-6f39417ef90a",
      "merchantId": "21491261-1a2c-4895-9628-966baea0356d"
    }),
});
const data = await response.json();

Response

200

{
  "success": false,
  "response": {
    "id": "89f8090b-364b-4d1b-b3f3-6f39417ef90a",
    "merchantId": "21491261-1a2c-4895-9628-966baea0356d",
    "billingLinkId": "f2fd17c1-5f51-472a-aa42-459a3201ac3b",
    "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-08-15T15:17:13.885Z",
    "updatedAt": "2024-08-15T15:17:13.885Z"
  }
}