---
title: "Create a plan"
method: POST
path: "/{companyDomain}/products/{productId}/plans"
---

# Create a plan

`POST /{companyDomain}/products/{productId}/plans`

Create a new plan for a specific product

## Path parameters

- `companyDomain` string, required
- `productId` integer, required

## Request body

- object
  - `name` string — The name of the plan you want to add
  - `displayName` string — The display name of the plan
  - `description` string — The description of the plan
  - `pricingModel` integer — The type of pricing model for the plan; FlatFee = 1, PerUnit = 2, Reserved = 3, Tiered = 4, Volume = 5, Ranged = 6
  - `featureTags` string — Any feature tags you want to add to the plan
  - `visibility` integer — The type of visibility of each plan; public, hidden and on-sale. Available values: 0, 1, 2, 3 (Public=0, Hidden=1, Internal=2, OffSale=3)
  - `redirectUrl` string — The URL you want to redirect your customers to when they have completed the checkout flow
  - `alertEmail` string — The email you would like to receive an alert when a customer signs up for this plan

## Response `200`

200

- object
  - `planId` integer
  - `name` string
  - `displayName` string
  - `description` string
  - `pricingModelType` integer
  - `productId` integer
  - `cycles` object[]
    - `cycleId` integer
    - `planId` integer
    - `pricingModel` object
      - `pricingModelId` integer
      - `frequency` integer
      - `frequencyType` integer
      - `freeTrial` integer
      - `freeTrialFrequencyType` integer
      - `contractTerm` integer
      - `contractTermFrequencyType` integer
      - `setupFeePrice` integer
      - `setupFeePriceFormatted` string
      - `freeQuantity` integer
      - `billingDateType` integer
      - `fixedBillingDateDay` integer
      - `proRateOption` integer
    - `visibility` string
  - `featureTags` string[]
  - `visibility` string
  - `redirectUrl` string
  - `hasActiveSubscription` boolean
  - `alertEmail` string

---

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