Release NotesAnnouncementsBlogFAQSupport
API Reference

Get subscriptions under a plan

get
{protocol}://{environment}/recurring/v1/plans//subscriptions

Retrieves subscriptions under a plan. Merchants can create subscriptions that associate customers with specific plans, including details such as customer billing information, card-on-file, scheduled payment amount, start date, and payment intervals.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Universally unique identifier (UUID) of the plan with subscriptions.

Query Params
customerUuids
array of strings

Universally unique identifier (UUID) of the customer.

customerUuids
int64

Subscription start date greater than value. Must be in the future.
Default: Next day.

int64

Subscription start date less than value.

int64

Subscription end date greater than value.

int64

Subscription end date less than value.

boolean

Indicates whether the subscription is currently active.
Values:
True
False

string

Indicates sort order value for the subscription.
Default: Name

integer

Plan limit.
Minimum value: 10

integer

Plan offset value.
Default: 0

Headers
string
required

Clover merchant identifier (mId).

string
required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <application>/<version>

Responses

Updated 2 months ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago