Sign in

v1

latestOpenAPI 3.0.32026-07-1336286494.8 KB
api

post/api/subscriptions/

Request body

start_datestring 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_datestring 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_renewboolean

Whether the subscription automatically renews. Defaults to true.

is_newboolean
customer_idstring nullable required

The id provided when creating the customer

plan_idstring uuid nullable

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.

metadataobject

A JSON object containing additional information about the subscription.

Response

subscription_idstring required
start_datestring date-time required

The time the subscription starts. This will be a string in yyyy-mm-dd HH:mm:ss format in UTC time.

end_datestring date-time required

The time the subscription starts. This will be a string in yyyy-mm-dd HH:mm:ss format in UTC time.

auto_renewboolean required

Whether the subscription automatically renews. Defaults to true.

is_newboolean required

Whether this subscription came from a renewal or from a first-time. Defaults to true on creation.

fully_billedboolean required
metadataobject required