Getting a subscription

The method allows you to get information about the subscription

Getting a subscription

post

Header parameters

x-api-public-keystringOptional

Public API-key

x-api-signaturestringOptional

Signing the request body with a private API-key

Content-typestringOptional

Request content type

Example: application/json

Body

Request body for getting subscription data

idstringRequired

Subscription ID

Example: 671fafbb-8795-4d0b-8614-06d5a6190f4e

merchantIdstringRequired

Merchant ID

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

Responses

application/json

objectOptional

Successful response

post

HTTPcURLJavaScriptPython

POST /api-gateway/recurrents/get-subscription HTTP/1.1
Host: ocp.onchainpay.io
Content-Type: application/json
Accept: */*
Content-Length: 97

{
  "id": "671fafbb-8795-4d0b-8614-06d5a6190f4e",
  "merchantId": "41fe615a-96dc-42c2-9629-196383411cd4"
}

200Success

{
  "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",
    "status": "PENDING",
    "message": null,
    "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"
  }
}