Retrieve a subscription

Developing

GET

/api/v1/subscriptions/{reference}

Fetch subscription details. It is scoped to your partner accont's environment

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Header Params

Responses

🟢200

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/v1/subscriptions/SUB-01KY2CFJWSJZNCZMTDDFF0KNE4' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json'

Response Example

Success

{
    "status": true,
    "message": "Subscription retrieved",
    "data": {
        "reference": "generated-reference",
        "amount": 1500,
        "status": "canceled",
        "interval": "month",
        "interval_count": 1,
        "total_cycles": null,
        "current_cycle": 0,
        "authorization_url": "http://127.0.0.1:8000/subscriptions/checkout/k0wtH4fexthwtWq",
        "access_code": "k0wtH4fexthwtWq",
        "metadata": {
            "order_id": 1
        },
        "callback_url": "http://localhost.php",
        "customer": {
            "email": "customer@mail.com",
            "created_at": "2026-07-20T13:05:51.000000Z",
            "updated_at": "2026-07-20T13:05:51.000000Z"
        },
        "current_period_start": null,
        "current_period_end": null,
        "cancelled_at": "2026-07-20T13:16:50.000000Z",
        "environment": "test",
        "created_at": "2026-07-20T13:05:51.000000Z",
        "updated_at": "2026-07-20T13:16:50.000000Z"
    }
}

Modified at 2026-08-26 15:39:22

Create Subscription

Cancel Subscription