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

# Get a plan

`GET /v1/plans/{planId}`

## Request

- Base URL: `https://sandbox.dev.clover.com/recurring`
- URL: `https://sandbox.dev.clover.com/recurring/v1/plans/{planId}`
- Auth: HTTP bearer

Retrieves a specific plan based on the planId . 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.

## Path parameters

- `planId` string, required

## Headers

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

## Response `200`

Successful response. Specific merchant plan is displayed.

- 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]( https://docs.clover.com/docs/working-with-recurring-payments-and-subscriptions#interval-matrix) 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.dev/clover/apis/ecommerce-recurring-apis.md) - [All operations](https://skmtc.dev/clover/apis/ecommerce-recurring-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/clover/apis/ecommerce-recurring-apis/revisions/c49bc4a5e5ed?raw)