Help DocsAPI DocsBusiness AcademyStatus
API Reference

Create Plan

post
https://api.baremetrics.com/v1//plans

Create a plan for use when creating or updating subscriptions.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🚧

Trials

When creating a subscription with a plan that has a trial, only the first plan will trigger a trial.

For example, if you create a subscription on Plan A, which has a 7 day trial, and then on day 2 you switch them to Plan B, the trial will continue until day 7, at which point they will become a paying customer on Plan B.

Path Params
string
required

Please see Sources

Body Params
string
required

Your unique ID for the plan

string
required

Your internal name for this plan. This will be displayed in the Plan Breakout section

string
required

The ISO code of the currency of this plan. E.G: usd

int32
required

How much is this plan? (In cents)

string
required

day, month or year

int32
required
int32
Defaults to 0

The duration of this trial. This is to be used in conjunction with trial_duration_unit

string
Defaults to day

This is to be used in conjunction with trial_duration

Responses

Updated about 1 year ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago