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

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.

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.

Response

200 - application/json
addon_subscription_id
string
required
customer
object
required
addon
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.

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.

parent
object
required
fully_billed
boolean
required
auto_renew
boolean
required

Whether the subscription automatically renews. Defaults to true.

metadata
object
required