---
title: "Update Plan Details"
method: PATCH
path: "/subscription/api/v1/subscription-plans/{planCode}"
tags: ["Subscription Plans"]
---

# Update Plan Details

`PATCH /subscription/api/v1/subscription-plans/{planCode}`

This endpoint updates the editable properties of an existing subscription plan, including its name, description, trial period, and billing limit.

## Path parameters

- `planCode` string, required

## Request body

- UpdateSubscriptionPlanRequest
  - `name` string — The updated name of the subscription plan.
  - `description` string — The updated description of the plan.
  - `trialPeriodDays` integer — The updated trial period in days.
  - `billingLimit` integer — The updated maximum number of billing cycles.

## Response `200`

Subscription plan details updated successfully

- UpdateSubscriptionPlanResponse
  - `success` boolean — Indicates if the request was successful.
  - `message` string — Descriptive message regarding the plan update operation.
  - `data` object — The payload containing the details of the updated plan.
    - `id` integer — Unique internal identifier for the plan.
    - `name` string — The name of the subscription plan.
    - `description` string — A brief overview or summary explaining what the plan offer entails.
    - `amount` number — The updated price of the plan.
    - `currency` string — The 3-letter ISO currency code for the billing.
    - `interval` string — The frequency of the billing cycle (e.g., MONTHLY).
    - `intervalCount` integer — The number of intervals between subscription billings.
    - `trialPeriodDays` integer — The number of free trial days given to subscribers.
    - `billingLimit` integer — The maximum number of times a subscriber can be charged on this plan.
    - `status` string — The operational status of the plan.
    - `planCode` string — The unique, system-generated code used to identify this plan.
    - `billingDaysOfWeek` string[], nullable — Specific days of the week scheduled for billing, if applicable.
    - `metadata` object, nullable — Key-value pairs for storing additional custom information.
    - `createdAt` string, date-time — Timestamp indicating exactly when the plan was created.
    - `updatedAt` string, date-time — Timestamp indicating when the plan record was last updated.

---

[API](https://skmtc.net/payaza/apis/payaza-documentation.md) · [All operations](https://skmtc.net/payaza/apis/payaza-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/payaza/payaza-documentation/versions/1ecd4b94ff07/schema)
