Get Subscription

This API allows partners to retrieve details of a subscription payment plan given its ID.

Retrieve details for a Recurring Payment Plan given its ID

GET https://<PayEngine-host>/api/merchant/:merchantId/recurring-payments/subscriptions/:subscriptionId

Request

Path Parameters

Name	Type	Description
merchant_id*	string	Merchant ID
subscription_id*	string	Subscription ID

200

Field Definitions

Field Name	Type	Description	Required?
merchant_id	string	Merchant ID	Required
data.subscription_id	string	PayPayEngine system ID for the subscription	Required
data. subscription_status	string	Subscription Status - ACTIVE, PENDING, CANCELLED, BLOCKED, EXPIRED	Required
data.plan_id	string	Recurring Payment Plan ID	Required
data.plan_name	string	Plan name	Required
data.billing_period	string	DAILY, WEEKLY, MONTHLY, YEARLY	Required
data.billing_start_date	string	Start date of Payment Link	Required
data.created_at	timestamp	Payment Link creation date	Required

Sample Request

curl --location --request GET '<API_HOST>/api/merchant/2be66e67-88a7-4e04-985d-0a1cfb0a648c/recurring-payments/subscriptions/e90c1de6-4e87-4c9e-bcbc-c535d6e349ec' \
--header 'Authorization: Basic <API_KEY>'

Sample Response

{
    "merchant_id": "1cc7b594-b80f-4227-a0fa-299c4c6ce8ab",
    "data": {
        "subscription_id": "a65ju",
        "subscription_status": "ACTIVE",
        "plan_id": "wlx57",
        "plan_name": "Basic",  
        "amount": 100.00,       
        "currency_code": "USD",
        "frequency": "MONTHLY",
        "installment_count": 2,
        "start_date": "2023-09-10T00:00:00.000Z",
        "created_date": "2023-09-08T00:00:00.000Z"
    }
}