v1

latestOpenAPI 3.0.12026-07-225791279.7 KB

Subscription Reads

Get Subscription

It retrieves the details of a specific subscription.

get/subscription/api/v1/subscriptions/{id}

Path parameters

idstring required

The Plan ID.

Response

Request Successful

successboolean

Indicates if the request was successful.

messagestring

Descriptive message regarding the operation.

Example response

{
  "success": true,
  "message": "Success",
  "data": {
    "id": 21,
    "customerId": "test-trial",
    "customerEmail": "johndoe@gmail.com",
    "status": "ACTIVE",
    "currentPeriodStart": "2026-07-08T20:20:32.893234",
    "currentPeriodEnd": "2026-07-09T20:20:32.893236",
    "nextChargeDate": "2026-07-09T20:20:32.893236",
    "connectionMode": "Live",
    "enrollmentReference": "SUBREF_FF29C28B70034065A6",
    "enrollmentTxnReference": "SUB_ENROLL_21_1783539495235",
    "chargeMode": "DIRECT_CHARGE",
    "createdAt": "2026-07-08T19:38:15.22973",
    "updatedAt": "2026-07-08T20:20:33.000927",
    "enrollConfirmed": true
  }
}