Skip to main content
POST
/
v1
/
plans
Create Plan
curl --request POST \
  --url https://api.monk.com/v1/plans \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Pro Plan",
  "description": "Our most popular plan",
  "status": "active",
  "currency": "usd",
  "netTerms": "30",
  "items": [
    {
      "pricingId": "price-flat-1234",
      "defaultQuantity": "1"
    },
    {
      "pricingId": "price-usage-5678",
      "defaultQuantity": "0"
    }
  ]
}
'
{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "status": "draft",
    "currency": "<string>",
    "netTerms": "<string>",
    "externalId": "<string>",
    "metadata": {
      "defaultAutoPayEnabled": true,
      "invoiceSendMethod": "<string>",
      "defaultCreditSettings": {
        "onDepletion": "<string>"
      },
      "defaultCreditGrantCents": 123
    },
    "items": [
      {
        "id": "<string>",
        "pricingId": "<string>",
        "productId": "<string>",
        "productName": "<string>",
        "pricingName": "<string>",
        "pricingModel": "<string>",
        "billingMode": "<string>",
        "defaultQuantity": "<string>",
        "isMetered": true
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}
All items must be recurring and share the same billing cadence. Auto-pay requires Net 0 terms. Scope: plans:write

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required
description
string
status
enum<string>
default:active
Available options:
draft,
active,
archived
currency
string
default:usd
netTerms
enum<string>
default:0
Available options:
0,
15,
30,
45,
60,
90
externalId
string
metadata
object
items
object[]

Response

Plan created

data
object