---
title: "Update a plan"
method: PUT
path: "/v1/plans/{planId}"
tags: ["PLANS"]
---

# Update a plan

`PUT /v1/plans/{planId}`

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.

## Path parameters

- `planId` string, required

## Headers

- `X-Clover-Merchant-Id` string, required
- `User-Agent` string, required

## Request body

- object
  - `name` string — Plan name. Cannot be null or blank. Length: Minimum 3 characters; Maximum 127 characters
  - `amount` integer — Plan amount.
  - `note` string — Additional information or note related to the plan.
  - `customerUuid` string — Universally unique identifier (UUID) of the customer.
  - `taxRateUuids` string[] — 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.
  - `tipAmount` integer — Amount paid in tips.
  - `active` boolean — Indicates whether the plan is currently active. Values: - True - False

## Response `200`

Successful response. Plan is edited.

- object
  - `id` string — Plan identifier.
  - `name` string — Plan name.
  - `merchantId` string — Merchant identifier.
  - `taxRateUuids` string[] — Tax rate universally unique identifiers (UUIDs).
  - `tipAmount` string — Tip amount.
  - `amount` string — Plan amount.
  - `active` boolean — 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.
  - `intervalCount` integer — Number of times the plan interval occurs.
  - `productUuid` string — Product universally unique identifier (UUID).
  - `note` string — Additional information or note related to the plan.
  - `createdTime` string, date-time — Time when the plan was created.
  - `modifiedTime` string, date-time — Time when the plan was modified.
  - `deletedTime` string, date-time — Time when the plan was deleted.
  - `subscriptionCount` integer — Number of subscriptions in the plan.
  - `subscriptionPaidTotalAmount` integer — Total paid amount for subscriptions in the plan.
  - `lastRunDate` string, date-time — Last run date for the plan.
  - `object` string

## Other responses

- `default` — Unexpected error.

---

[API](https://skmtc.net/clover/apis/platform-api.md) · [All operations](https://skmtc.net/clover/apis/platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/clover/platform-api/revisions/08da265101a3/schema)