Create a subscription
Add a plan to a customer’s subscription
A subscription associates one of your customers with one of your billing plans. You can safely give a customer multiple subscriptions to different plans.
If you want to give a single customer multiple subscriptions to the same plan (for example, one for each of their environments), you can do that using subscription_filters. For more details on how to use them and what they do, see the subscription filters documentation.
If any of your usage components has a prepaid charge associated with it, you can specify how many units they prepaid for as part of this call. If you don’t specify a value, the component’s default value will be used. If there was no default value, the susbcription creation will fail.
Authorizations
Token-based authentication with required prefix "Token"
Body
The date the subscription starts. This should be a string in YYYY-MM-DD format of the date in UTC 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.
Whether the subscription automatically renews. Defaults to true.
Add filter key, value pairs that define which events will be applied to this plan subscription.
The id provided when creating the customer
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.
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.
A JSON object containing additional information about the subscription.
Response
The time the subscription starts. This will be a string in yyyy-mm-dd HH:mm:ss format in UTC time.
The time the subscription starts. This will be a string in yyyy-mm-dd HH:mm:ss format in UTC time.
Whether the subscription automatically renews. Defaults to true.
Whether this subscription came from a renewal or from a first-time. Defaults to true on creation.