POST
/
api
/
subscriptions
/
{subscription_id}
/
components
/
{metric_id}
/
change_prepaid_units
/
curl --request POST \
  --url https://api.uselotus.io/api/subscriptions/{subscription_id}/components/{metric_id}/change_prepaid_units/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "invoice_now": true,
  "units": 123
}'
{
  "addons": [
    {
      "addon": {
        "addon_id": "<string>",
        "addon_name": "<string>",
        "addon_type": "flat",
        "billing_frequency": "one_time"
      },
      "addon_subscription_id": "<string>",
      "end_date": "2023-11-07T05:31:56Z",
      "fully_billed": true,
      "start_date": "2023-11-07T05:31:56Z"
    }
  ],
  "auto_renew": true,
  "billing_plan": {
    "plan_id": "<string>",
    "plan_name": "<string>",
    "version": 123,
    "version_id": "<string>"
  },
  "customer": {
    "customer_id": "<string>",
    "customer_name": "<string>",
    "email": "jsmith@example.com"
  },
  "end_date": "2023-11-07T05:31:56Z",
  "fully_billed": true,
  "is_new": true,
  "metadata": {},
  "start_date": "2023-11-07T05:31:56Z",
  "subscription_filters": [
    {
      "property_name": "<string>",
      "value": "<string>"
    }
  ],
  "subscription_id": "<string>"
}
lotus.change_prepaid_units(
    subscription_id='sub_a623349004cd4947aca1851c64aa6fbd',
    metric_id='metric_a47ac0bf',
    units=32,
    invoice_now=true
)

In Lotus, you can define a certain number of units to be “prepaid” for a subscription. For example, if your business uses seats as a metric, you could define that your plan has 5 seats “prepaid” for each subscription. This means that the subscription will have 5 seats available for use, and you can add more seats as needed.

This feature lets you have the benefits or charging flat fees in advance, while still metering the usage of the metric and allowing you to add more units as needed.

This API is not currently available in our SDKs, but please contact us if you would like to use it as part of your workflow.

If the change decreases the number of prepaid units, then the difference is awarded to the customer as a credit. If it icnreases, then you can choose between invoicing the difference immediately or adding it to the next invoice.

Authorizations

Authorization
string
headerrequired

Token-based authentication with required prefix "Token"

Path Parameters

metric_id
string
required

The ID of the metric to alter the prepaid usage for.

subscription_id
string
required

The ID of the subscription which will have its plans switched.

Body

invoice_now
boolean
default: true

Whether or not to immediately invoice the customer for the change in prepaid units.

units
number
required

The new prepaid units for the customer.

Response

200 - application/json
addons
object[]
required
auto_renew
boolean
required

Whether the subscription automatically renews. Defaults to true.

billing_plan
object
required
customer
object
required
end_date
string
required

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

fully_billed
boolean
required
is_new
boolean
required

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

metadata
object
required
start_date
string
required

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

subscription_filters
object[]
required
subscription_id
string
required