Release NotesAnnouncementsBlogFAQSupport
API Reference
Start typing to search…

Create a plan

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

Creates a merchant plan 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.

Body Params
string
required
length ≤ 127

Plan name. Cannot be null or blank.
Length: Minimum 3 characters; Maximum 127 characters

int64
required

Plan amount.

string
length ≤ 255

Additional information or note related to the plan.

taxRateUuids
array of strings

Tax rate universally unique identifier (UUID).
Use the Get all tax rates endpoint to retrieve merchant tax UUID information.
Length: Maximum length of combined UUIDs is 255 characters.

taxRateUuids
int64

Amount paid in tips.

string
enum
required

Interval of the plan.
Values:

  • Day
  • Week
  • Month
  • Year
Allowed:
int64
required

Number of intervals in the plan.

Headers
string
required

Clover merchant identifier (mId).

Responses

Updated 15 days ago

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