API Reference

Subscription line object

Attributes


id

string
The unique object identifier.


plan

string
The ID of the object for this subscription line.


quantity

decimal
Quantity of the plan to be billed.


coupon

string
The ID of the object to discount the plan for this subscription line. Only coupons with apply_on: line are applicable.


coupon_redemptions

number
Number of times the coupon has been applied to the subscription line.


created

datetime
Date and time of the creation of this subscription line.


updated

datetime
Date and time of the last update of this subscription line.


Object sample

{
    "id": "lin_c7I7JP8I1W2axLybt8",
    "plan": {
        "id": "pla_kfRahy05LQ7MjtqZj8",
        "tiers": [],
        "sku": null,
        "name": "Awesome APP",
        "description": "Monthly charge subscription",
        "product": "pro_nZsj9TeVwHmvbnL8iE",
        "amount": 75.0,
        "tiers_mode": null,
        "exempt": false,
        "usage_scheme": "licensed",
        "usage_aggregation": null,
        "frequency": {
            "id": "monthly",
            "name": "Mensual"
        },
        "currency": {
            "id": "USD",
            "conversion": null,
            "name": "American Dollar",
            "name_en": "American Dollar",
            "default": true,
            "is_chargeable": true,
            "available": true,
            "rounded": false,
            "country": "US"
        },
        "status": "active",
        "archived": null,
        "created": "2021-01-28T17:32:00.250476-03:00",
        "updated": "2021-01-28T17:32:00.250501-03:00",
    },
    "quantity": 1,
    "coupon": null,
    "coupon_redemptions": 0,
    "created": "2021-01-28T17:35:00.546879-03:00",
    "updated": "2021-01-28T17:35:00.546900-03:00"
}