---
title: "Create a Plan"
method: POST
path: "/v1/plans"
---

# Create a Plan

`POST /v1/plans`

This API creates a new plan.

## Headers

- `Accept` string, required
- `Content-Type` string, required

## Request body

- object
  - `amount` integer, required — A positive integer in cents representing how much to charge.<br><style></style><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Format</b></td><td style='text-align: center;'><b>Min Length</b></td><td style='text-align: center;'><b>Max Length</b></td><td style='text-align: center;'><b>Examples</b></td></tr><tr><td>Numeric (in cents)</td><td>50</td><td>10000000</td><td>`9` would be $0.09 10,000,000 would be $100,000.00</td></tr></table>
  - `plan_type` 'physical' | 'digital', required — The type of plan.<br><style>td </style><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Format</b></td><td style='text-align: center;'><b>Allowed Values</b></td></tr><tr><td>Alphabetic</td><td>`physical` `digital`</td></tr></table>
  - `name` string, required — Name of the plan.<br><style></style><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Format</b></td><td style='text-align: center;'><b>Min Length</b></td><td style='text-align: center;'><b>Max Length</b></td><td style='text-align: center;'><b>Examples</b></td></tr><tr><td>Alphanumeric and Special Characters</td><td>3 characters</td><td>50 characters</td><td>`mynewplanname`</td></tr></table>
  - `interval` 'day' | 'month' | 'week' | 'year', required — The unit of interval for billing a plan.<br><style></style><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Format</b></td><td style='text-align: center;'><b>Allowed Values</b></td></tr><tr><td>Alphabetic</td><td>`day` `month` `week` `year`</td></tr></table>
  - `statement_descriptor` string, required — An arbitrary string to be displayed on a plan.<br><style></style><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Format</b></td><td style='text-align: center;'><b>Min Length</b></td><td style='text-align: center;'><b>Max Length</b></td><td style='text-align: center;'><b>Examples</b></td></tr><tr><td>Alphanumeric and Special Characters</td><td>5 characters</td><td>25 characters</td><td>A1 Company 888-888-8888`</td></tr></table>
  - `interval_count` integer — The frequency of billing.<br><style></style><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Format</b></td><td style='text-align: center;'><b>Allowed Values</b></td><td style='text-align: center;'><b>Notes</b></td></tr><tr><td>Numeric</td><td>Days: `1 - 365` Months: `1 - 12` Weeks: `1 - 52` Years: `1`</td><td>`interval`: `interval_count`(frequency) | what it means? `days`: `2` | You will be billed every two days. `months`: `3` | You will be billed every 3 months. `weeks`: `4` | You will be billed every 4 weeks. `years`: `1` | You will be billed every 1 year.</td></tr></table>
  - `trial_period_days` integer — Number of days of the trial period that a customer is not charged for.<br><style></style><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Format</b></td><td style='text-align: center;'><b>Allowed Values</b></td></tr><tr><td>Numeric</td><td>`0 - 365`</td></tr></table>
  - `plan_id` string — An ID that refers to a newly created plan.<br><style></style><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Format</b></td><td style='text-align: center;'><b>Min Length</b></td><td style='text-align: center;'><b>Max Length</b></td><td style='text-align: center;'><b>Examples</b></td><td style='text-align: center;'><b>Notes</b></td></tr><tr><td>Alphanumeric and Special Characters</td><td>3 characters</td><td>191 characters</td><td>`mynewplan_1`<br>`plan_de2c4146` - if PAYARC generated one.</td><td>Users can create a custom plan ID or PAYARC will generate one automatically.</td></tr></table>
  - `plan_description` string — An arbitrary string that describes a plan.<br><style></style><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Format</b></td><td style='text-align: center;'><b>Notes</b></td></tr><tr><td>Alphanumeric and Special Characters</td><td>**Min​⬤</td></tr></table>
  - `currency` string — The alphabetic currency code, based on ISO standard<br><style></style><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Format</b></td><td style='text-align: center;'><b>Examples</b></td></tr><tr><td>Three-letter ISO currency code, in lowercase.</td><td>The US dollar is represented as USD – the US coming from the ISO 3166 country code and the D for dollar.</td></tr></table>
  - `surcharge_applicable` integer — Surcharge option<br><style></style><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Notes</b></td></tr><tr><td>Enabling this option will apply surcharge to the plan amount. Please contact support@payarc.com to configure the surcharge value.</td></tr></table>

## Response `201`

201

- object
  - `data` object
    - `object` string
    - `id` string
    - `real_id` integer
    - `amount` string
    - `interval` string
    - `interval_count` string
    - `name` string
    - `description` unknown
    - `statement_descriptor` string
    - `trial_period_days` string
    - `currency` string
    - `created_at` object
      - `date` string
      - `timezone_type` integer
      - `timezone` string
    - `updated_at` object
      - `date` string
      - `timezone_type` integer
      - `timezone` string
  - `meta` object
    - `include` unknown[]
      - unknown
    - `custom` unknown[]
      - unknown

## Other responses

- `422` — 422

---

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