Create a Subscription

post

https://api.brilo.tech/api/subscriptions/

Creates a new subscription for a customer and initiates the billing cycle.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

start_date

date-time

required

The date the subscription starts. This should be a string in YYYY-MM-DD format of the date in UTC time.

end_date

date-time

The date the subscription ends. This should be a string in YYYY-MM-DD format of the date in UTC time. If you don’t set it (recommended), we will use the information in the billing plan to automatically calculate this.

auto_renew

boolean

Whether the subscription automatically renews. Defaults to true.

is_new

boolean

subscription_filters

array of objects

Add filter key, value pairs that define which events will be applied to this plan subscription.

subscription_filters

customer_id

string | null

required

The id provided when creating the customer

plan_id

uuid | null

The Lotus plan_id, found in the billing plan object. We will make a best-effort attempt to find the correct plan version (matching preferred currencies, prioritizing custom plans), but if more than one plan version or no plan version matches these criteria this will return an error.

component_fixed_charges_initial_units

array of objects

The initial units for the plan components' prepaid fixed charges. This is only required if the plan has plan components where you did not specify the initial units.

component_fixed_charges_initial_units

metadata

object

A JSON object containing additional information about the subscription.

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Response

201