Retrieve a List of Subscription Based on Different Options

Integrators will be able to retrieve a list of subscription based on the different options available. The three options are shown in the table below:

🚧

Important:

Integrators must provide either "customerId" or a "status" when retrieve the list of subscription using the Ezypay API.

Available Parameters:

Description:

customerId

Integrators are able to use Ezypay's customer UUID to retrieve all subscriptions associated with the customer.

status

Integrators are able to retrieve a list of subscription based on what the current status is for the subscriptions.

Status available are:
ACTIVE, FUTURE, PENDING, PAST_DUE, PENDING_CANCELLATION, CANCELLED and COMPLETED.

fitlerNullPaymentMethods

Integrators are able to retrieve a list of subscription which does not have any payment method linked to the subscription.

Integrators are able to retrieve a list of subscription which currently have a payment method associated to the subscriptions.

📘

Documentation of the reference API can be found in:
https://developer.ezypay.com/reference/list-subscriptions


Did this page help you?