Release NotesAnnouncementsBlogFAQSupport
API Reference

Get all plans

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

Retrieves a set of merchant plans that customers can use to initiate automatic payments. Each plan defines a fixed amount, periodic frequency, tax, convenience fees, tips, and so on. You can create as many recurring payment plans as required.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean

Indicates whether the plan is currently active.
Values:

  • True
  • False
string

Plan name.
Length: Minimum 3 characters; Maximum 127 characters

string

Plan interval. Example: Daily, weekly, semi-monthly, monthly, quarterly, yearly.
See Interval Matrix table for details.

integer

Number of plan intervals.

string

Indicates sort order value for the plans.
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