---
title: "Create a Subscription Plan"
method: POST
path: "/v1/subscription-plan"
---

# Create a Subscription Plan

`POST /v1/subscription-plan`

A subscription plan consists of basic information like plan name, amount, and frequency. An example of a subscription plan could be “Spotify Premium Membership” which is SGD 9.90 monthly.

## Headers

- `X-BUSINESS-API-KEY` string, required

## Request body

- object
  - `name` string, required — Plan name. It's required field
  - `description` string — The description of subscription plan
  - `cycle` 'weekly' | 'monthly' | 'yearly' | 'custom', required — Billing frequency (weekly / monthly / yearly / custom). If cycle = custom then the user has to send the fields cycle_repeat and cycle_frequency
  - `cycle_frequency` 'day' | 'week' | 'month' | 'year' — [This field is only applicable when cycle = custom] It's the frequency of the cycle [day / week / month / year]
  - `cycle_repeat` integer — [This field is only applicable when cycle = custom] It's the number of times the cycle will repeat.
  - `currency` string
  - `reference` string — Arbitrary reference number that you can map to your internal reference number. This value cannot be edited by the customer
  - `redirect_url` string — The redirected URL after the payment
  - `start_date_method` 'sign_up_date' | 'customer_select_date' | 'fixed_date'
  - `fixed_date` number — it's required if start_date_method = fixed_date
  - `times_to_be_charged` number

## Response `200`

200

- object
  - `id` string
  - `name` string
  - `description` string
  - `cycle` string
  - `cycle_repeat` unknown
  - `cycle_frequency` unknown
  - `currency` string
  - `amount` number
  - `reference` string
  - `created_at` string
  - `updated_at` string

## Other responses

- `422` — 422

---

[API](https://skmtc.net/hitpayapp/apis/hitpay-api.md) · [All operations](https://skmtc.net/hitpayapp/apis/hitpay-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hitpayapp/hitpay-api/versions/6aae1a736990/schema)