Sign in

v1

latestOpenAPI 3.0.12026-07-242871595.3 MB
PLANS

Update a plan

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.

put/v1/plans/{planId}

Path parameters

planIdstring required

Universally unique identifier (UUID) of a plan.

Headers

X-Clover-Merchant-Idstring required

Clover merchant identifier (mId).

User-Agentstring required

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

Request body

namestring

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

amountinteger

Plan amount.

notestring

Additional information or note related to the plan.

customerUuidstring

Universally unique identifier (UUID) of the customer.

taxRateUuidsstring[]

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.

tipAmountinteger

Amount paid in tips.

activeboolean

Indicates whether the plan is currently active. Values:

  • True
  • False

Example request

{
  "note": "note",
  "amount": 0,
  "customerUuid": "customerUuid",
  "tipAmount": 6,
  "name": "name",
  "active": true,
  "taxRateUuids": [
    "taxRateUuids",
    "taxRateUuids"
  ]
}

Response

Successful response. Plan is edited.

idstring

Plan identifier.

namestring

Plan name.

merchantIdstring

Merchant identifier.

taxRateUuidsstring[]

Tax rate universally unique identifiers (UUIDs).

tipAmountstring

Tip amount.

amountstring

Plan amount.

activeboolean

Indicates whether the plan is active. Values:

  • True
  • False
interval'DAY' | 'MONTH' | 'WEEK' | 'YEAR'

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

intervalCountinteger

Number of times the plan interval occurs.

productUuidstring

Product universally unique identifier (UUID).

notestring

Additional information or note related to the plan.

createdTimestring date-time

Time when the plan was created.

modifiedTimestring date-time

Time when the plan was modified.

deletedTimestring date-time

Time when the plan was deleted.

subscriptionCountinteger

Number of subscriptions in the plan.

subscriptionPaidTotalAmountinteger

Total paid amount for subscriptions in the plan.

lastRunDatestring date-time

Last run date for the plan.

objectstring

Example response

{
  "note": "note",
  "modifiedTime": "2000-01-23T04:56:07.000Z",
  "amount": "amount",
  "tipAmount": "tipAmount",
  "subscriptionCount": 6,
  "active": true,
  "lastRunDate": "2000-01-23T04:56:07.000Z",
  "taxRateUuids": [
    "taxRateUuids",
    "taxRateUuids"
  ],
  "productUuid": "productUuid",
  "merchantId": "merchantId",
  "subscriptionPaidTotalAmount": 1,
  "intervalCount": 0,
  "name": "name",
  "createdTime": "2000-01-23T04:56:07.000Z",
  "interval": "DAY",
  "id": "id",
  "deletedTime": "2000-01-23T04:56:07.000Z",
  "object": "object"
}