POST
/
api
/
subscriptions
/
{subscription_id}
/
addons
/
attach
/
Authorization
Path
Body
curl --request POST \
  --url https://api.uselotus.io/api/subscriptions/{subscription_id}/addons/attach/ \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "addon_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": {},
  "quantity": 2
}'
{
  "addon": {
    "addon_id": "<string>",
    "addon_name": "<string>",
    "addon_type": "flat",
    "billing_frequency": "one_time"
  },
  "addon_subscription_id": "<string>",
  "auto_renew": true,
  "customer": {
    "customer_id": "<string>",
    "customer_name": "<string>",
    "email": "jsmith@example.com"
  },
  "end_date": "2023-11-07T05:31:56Z",
  "fully_billed": true,
  "metadata": {},
  "parent": {
    "addons": [],
    "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": {},
    "plan_detail": {
      "plan_id": "<string>",
      "plan_name": "<string>",
      "version": 123,
      "version_id": "<string>"
    },
    "start_date": "2023-11-07T05:31:56Z",
    "subscription_filters": [],
    "subscription_id": "<string>"
  },
  "start_date": "2023-11-07T05:31:56Z"
}
lotus.attach_addon(
  subscription_id='sub_e953bfbf42a442ca90079c8f1656d306',
  addon_id='addon_5af61a194ca144478fb2721dd34c9049',
  quantity=3,
)

Authorizations

Authorization
string
headerrequired

Token-based authentication with required prefix "Token"

Path Parameters

subscription_id
string
required

The ID of the subscription to add an addon to.

Body

addon_id
string

The add-on to be applied to the subscription.

metadata
object

A JSON object containing additional information about the add-on subscription. This will be returned in the response when you retrieve the add-on subscription.

quantity
integer
default: 1

The quantity of the add-on to be applied to the subscription. Flat fees of add-ons will be multiplied by this quantity. Usage-based components of add-ons will be unaffected by the quantity.

Response

200 - application/json
addon
object
required
addon_subscription_id
string
required
auto_renew
boolean
required

Whether the subscription automatically renews. Defaults to true.

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
metadata
object
required
parent
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.

Change Prepaid UnitsCancel an Add-On