GET
/
subscription
/
get-subscription
/
{subscriptionId}
curl --request GET \
  --url https://api.xpaycheckout.com/subscription/get-subscription/{subscriptionId} \
  --header 'Authorization: Basic <encoded-value>'
{
  "subscriptionId": "66f53a6e2097773e4f0112c8",
  "interval": "MONTH",
  "intervalCount": 2,
  "cycleCount": 2,
  "remainingCycleCount": 2,
  "currency": "USD",
  "amount": 100,
  "presentmentCurrency": "USD",
  "mode": "TEST",
  "createdAt": "2024-09-26T10:41:50.472+00:00",
  "status": "CREATED",
  "description": "Order for 2 items",
  "upfrontAmount": 200,
  "metadata": {
    "orderId": "12345",
    "customerNote": "Deliver after 5 PM"
  }
}

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

subscriptionId
string
required

Unique identifier of the subscription

Example:

"66f53a6e2097773e4f0112c8"

Response

200
application/json

Successful response with subscription details

The response is of type object.