Get Merchant Subscriptions

Retrieve the merchant's active product subscriptions — Payment, Loyalty & Voucher, Market Place, or Social Media.

When to Use

▾

Use this endpoint when:

• You need to know which RM products the merchant has subscribed to
• Checking subscription expiry or termination dates
• Gating UI features based on the merchant's plan

How to Use

▾

Endpoint

GET/v3/merchant/subscriptions

Step 1: Authenticate

▾

Obtain a valid accessToken for the merchant.

Step 2: Send the GET Request

▾

No request body or query parameters required.

Step 3: Iterate item

▾

The response item array contains one entry per active subscription.

---

Request Parameters

▾

No request body. Authenticated headers only.

---

Response Parameters

▾

itemARRAY

List of active subscriptions.

idINTEGER

Subscription ID. `1000` = Loyalty & Voucher, `1001` = Payment, `1002` = Market Place, `1003` = Social Media.

Example: 1001

gracePeriodINTEGER

Grace period in days before termination.

Example: 90

expiryAtDATETIME

Subscription expiry timestamp.

Example: "2018-04-28T06:36:08Z"

terminateAtDATETIME

Termination timestamp after grace period ends.

Example: "2018-07-27T23:59:59Z"

statusSTRING

Status — `"ACTIVE"`, `"REVIEWING"`, `"SUSPEND"`, `"PENDING"`.

Example: "ACTIVE"

codeSTRING

`"SUCCESS"` if the call succeeded. Otherwise returns an error code. See [Error Codes](../../error-codes).

Example: "SUCCESS"