---
title: "Patch payment plans"
method: PATCH
path: "/payment-plans"
tags: ["Payment Plans"]
---

# Patch payment plans

`PATCH /payment-plans`

Partially update one or more existing payment plans. 
Each specified payment plan must contain one or fields in the request body to update.

## Headers

- `api-token` string, required

## Request body

- PaymentPlanPatchReq
  - `paymentPlans` BasePaymentPlanPatch[]
    - `id` integer, required — The id of the payment plan being patched.
    - `name` string — The new payment plan name.
    - `description` string — Additional information describing the new payment plan.
    - `status` 'active' | 'inactive'
    - `cardTerminalId` integer — The card terminal that will process card transactions for subscriptions to the payment plan.
    - `setupAmount` number, float — The initial monetary amount charged for new subscriptions to the payment plan. Can be charged immediately or with the first recurring billing.
    - `recurringAmount` number, float — The recurring monetary amount charged for subscriptions to the payment plan. Note a plan can have a recurring amount of zero, however all subscriptions to the plan must then individually specify their charged recurring amount.
    - `billSetupImmediately` 'first_billing' | 'immediate'
    - `freeTrialPeriod` integer — The free trial length (in days) subscriptions to the payment plan can have
    - `taxType` 'no_tax' | 'customer' | 'merchant'
    - `taxCalculation` 'country_only' | 'country_province' | 'province_only'
    - `paymentMethod` 'card' | 'bank' | 'card_bank'
    - `addOnIds` integer[] — List of add-ons to link to this payment plan and allow subscriptions to apply
    - `emailSettingRecurringQueue` string — Whether recurring queue emails are sent to the merchant. BusinessEmail must not be empty if emailSettingRecurringQueue is set to `merchant`. Not including this setting will default to not sending emails. * `off` - Setting value for no emails * `merchant` - Setting value to send recurring queue emails to the merchant
    - `businessEmail` string — Merchant email used for subscriptions emails. Must not be empty if emailSettingRecurringQueue is `merchant`.
    - `isProrated` string — Identifies whether or not a payment plan is prorated. Subscriptions to prorated plans will charge a prorated first payment on the activation date or after the free trial period has ended. Note that prorated amounts include the recurring amount and recurring add-ons amount. Setup amounts and one-time add-ons are not prorated. Defining this value requires the the payment plan's `type` to be `cycle`. * `yes` - Payment plan is prorated * `no` - Payment plan will not be prorated

## Response `200`

Successful payment plan patch. The response body contains the data representation of all updated  payment plans.

- PaymentPlanPatchRes
  - `data` BasePaymentPlan[]
    - `id` integer
    - `dateCreated` string
    - `dateUpdated` string
    - `name` string
    - `description` string
    - `type` string
    - `status` string
    - `currency` string
    - `cardTerminalId` number, float
    - `setupAmount` number, float
    - `recurringAmount` number, float
    - `billSetupImmediately` string
    - `billingPeriod` string
    - `billingPeriodIncrements` integer
    - `dateBilling` string
    - `termType` string
    - `freeTrialPeriod` integer
    - `taxType` string
    - `taxCalculation` string
    - `termLength` integer
    - `paymentMethod` string
    - `businessEmail` string
    - `addOnIds` integer[]

## Other responses

- `400` — You are initiating a request with invalid parameter and/or body values.
- `401` — You are not authorized to access this resource. Please ensure that you are authenticated, and that you are using the `api-token` header
- `403` — You do not have permission to access this resource. Please ensure you are both authenticated and that you have the required roles/permissions active.
- `500` — Helcim internal server error encountered.

---

[API](https://skmtc.net/helcim/apis/the-helcim-api.md) · [All operations](https://skmtc.net/helcim/apis/the-helcim-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/helcim/the-helcim-api/versions/345052ca6578/schema)