Release NotesAnnouncementsBlogFAQSupport
API Reference

Update a plan

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

Updates a merchant plan that customers can use to initiate automatic payments. Each plan defines the fixed amount, periodic frequency, tax, convenience fees, tip, 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…
Path Params
string
required

Universally unique identifier (UUID) of a plan.

Body Params
string

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

int64

Plan amount.

string

Additional information or note related to the plan.

string

Universally unique identifier (UUID) of the customer.

taxRateUuids
array of strings

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

taxRateUuids
int64

Amount paid in tips.

boolean

Indicates whether the plan is currently active.
Values:

  • True
  • False
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