Sign in
api

A simple ViewSet for viewing and editing Subscriptions.

post/api/subscriptions/add/

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 required

The id provided when creating the customer

plan_idstring uuid required

The Lotus plan_id, found in the billing plan object

Response

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

Whether the subscription has been fully billed and finalized.

Changes