Skip to content
SkillPouchSkillPouch Docs

Create a plan (paid plans get a provider product)

POST
/v1/admin/plans
curl --request POST \
  --url https://app.skillpouch.net/v1/admin/plans \
  --header 'Content-Type: application/json' \
  --data '{ "slug": "example", "name": "example", "description": "", "price_cents": 1, "currency": "usd", "interval": "month", "pouch_limit": 1, "storage_bytes": 1, "is_public": true, "is_active": true, "sort": 0, "reason": "" }'

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
slug
string
/^[a-z0-9-]{2,64}$/
name
required
string
>= 1 characters <= 100 characters
description
string
"" <= 1000 characters
price_cents
required
integer
<= 9007199254740991
currency
string
default: usd >= 3 characters <= 3 characters
interval
required
Any of:
string
Allowed values: month year
pouch_limit
required
integer
<= 9007199254740991
storage_bytes
required
integer
<= 9007199254740991
is_public
boolean
default: true
is_active
boolean
default: true
sort
integer
0 >= -9007199254740991 <= 9007199254740991
reason
string
"" <= 500 characters

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
ok
required
boolean
data
required
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
slug
required
string
name
required
string
description
required
string
price_cents
required
integer
>= -9007199254740991 <= 9007199254740991
currency
required
string
interval
required
Any of:
string
Allowed values: month year
pouch_limit
required
integer
>= -9007199254740991 <= 9007199254740991
storage_bytes
required
integer
>= -9007199254740991 <= 9007199254740991
polar_product_id
required
string | null
is_default
required
boolean
is_public
required
boolean
is_active
required
boolean
sort
required
integer
>= -9007199254740991 <= 9007199254740991
meta
required
object
request_id
required
string
next_cursor
string | null

Example 

{
  "ok": true,
  "data": {
    "interval": "month"
  }
}