Skip to main content
POST
Create a subscription plan

Authorizations

X-API-Key
string
header
required

Company API key. Send in the X-API-Key header.

Headers

x-client-id
string
required

Client identifier for the company in the request.

Example:

"client_abc123"

Body

application/json
name
string
required

Display name for the plan (max 255 chars).

Example:

"Basic Monthly"

amount
integer
required

Plan price in cents (e.g. 2990 = R$29,90).

Example:

2990

interval
enum<string>
required

Billing frequency.

Available options:
weekly,
monthly,
yearly
Example:

"monthly"

description
string | null

Optional description (max 1000 chars).

Example:

"Access to all basic features."

currency
string | null

3-letter ISO currency code. Defaults to BRL.

Example:

"BRL"

interval_count
integer | null

Number of intervals between charges (e.g. 3 + monthly = every 3 months). Min 1, max 365.

Example:

1

trial_period_days
integer | null

Free trial days before first charge (1–365).

Example:

7

billing_day
integer | null

Day of the month to charge (1–28). Defaults to the subscription creation day.

Example:

5

min_card_months
integer | null

Minimum months the card must be valid at subscription creation (1–120). Null or absent = no restriction.

Example:

3

Response

Plan created

data
object