Create Subscription

This endpoint allows you to create a Subscription.

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

You will need to create a Customer and Plan before you can use this endpoint.

❗️

It may take a while for your subscriptions to appear in your metrics. There may also be a delay in the data being fully displayed in the GET /subscriptions endpoint.

🚧

How and why do I use addons?

Addons are used to add additional charges to a base plan. They allow you to create a variety of different combinations of features without creating a separate plan for each possible combination.

Let's look at a hypothetical way of charging for Baremetrics.

We could have a base subscription of $25/mo. Additional features like dunning, customer profiles, etc. could be treated as an addon.

$25/mo. base charge + $25 addon for Dunning = $50/mo.

📘

We will automatically create charges for your subscriptions. If you don't want this to happen, then please contact us.

Path Params
string
required

Please see Sources

Body Params
string
required

Your unique ID for the subscription

date-time
required

A unix timestamp of when this subscription started

date-time

A unix timestamp of when this subscription was, or should be canceled. This cannot be changed, so only set this if you are certain you know when the subscription will end.

string
required

Your unique ID for the plan

string
required

Your unique ID for the customer

addons
array of objects
addons
int32
Defaults to 1
int32

Integer value (in the same currency as the plan)

Responses

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