API Reference

Subscription addon object

Attributes


id

string
The unique object identifier.


addon

string
The ID of the object for this subscription line.


addon_redemptions

number
Number of times the addon has been applied to the subscription.


quantity

decimal
Quantity of the addon to be billed.


rates

array
The list of objects for this subscription addon. Only applicable for addons with apply_scheme: one_time.


Object sample

{
    "addon": {
        "id": "add_zA83APXQDm2tQZL7uo",
        "apply_scheme": "one_time",
        "duration_times": null,
        "sku": null,
        "name": "Setup",
        "description": "Setup service",
        "amount": 30.8,
        "currency": {
            "id": "USD",
            "conversion": false,
            "name": "American Dollar",
            "name_en": "American Dollar",
            "default": true,
            "is_chargeable": true,
            "available": true,
            "rounded": false,
            "country": "US"
        },
        "metadata": {},
        "archived": null,
        "status": "active",
        "created": "2020-05-15T12:53:44.599408-04:00",
        "updated": "2020-06-11T07:54:15.463443-04:00",
    },
    "addon_redemptions": 0,
    "quantity": 1,
    "rates": []
}