Subscription Manager API

The PayHere Subscription Manager API lets you view, retry, and cancel your subscription customers, who were subscribed using the Recurring API.

This API has three endpoints:

• List all subscriptions
• List all payments of a subscription
• Retry a subscription
• Cancel a subscription

List all subscriptions

To list all subscriptions, use the following endpoint:

GET /payhere/api/subscriptions

List all payments of a subscription

To list all payments of a specific subscription, use the following endpoint:

GET /payhere/api/subscriptions/:id

Replace :id with the subscription ID.

Retry a subscription

To retry a subscription, use the following endpoint:

POST /payhere/api/subscriptions/:id/retry

Replace :id with the subscription ID.

Cancel a subscription

To cancel a subscription, use the following endpoint:

DELETE /payhere/api/subscriptions/:id

Replace :id with the subscription ID.