Create Plan

Create a subscription plan — the price, how often it bills, and how long a late payer has to catch up.

Request authentication

This endpoint requires a Secret Key (sk_...) passed in either the x-api-key header or as a Bearer token in the Authorization header.

string

required

What customers see on the plan, for example Pro monthly.

number

required

The price per billing period, in currency.

string

required

How often the plan bills: day, week, month or year.

string

default:"USD"

The fiat currency the plan is priced in. Customers pay the stablecoin equivalent.

integer

default:"1"

Bill every N intervals. 3 with month is quarterly.

integer

default:"0"

A free trial before the first charge.

integer

default:"7"

Days after a period ends that a subscriber can still pay before the subscription expires. Between 0 and 30.

string

default:"invoice"

invoice sends a pay link each cycle. auto_debit pulls on-chain from an approved allowance. both lets the subscriber choose.

string

What subscribers get on this plan.

object

Any key-value data you want stored alongside the plan.