Skip to content
Lark
Book a demoContact usGet started
API Reference
Subscription Timelines
Items

Create Subscription Timeline Items

subscription_timelines.items.create(strsubscription_timeline_id, ItemCreateParams**kwargs) -> ItemCreateResponse
post/subscription-timelines/{subscription_timeline_id}/items

Create Subscription Timeline Items

ParametersExpand Collapse
subscription_timeline_id: str
items: Iterable[Item]

The items to create for the subscription timeline.

period: ItemPeriod

The period of the subscription timeline item.

end: Union[str, datetime, null]
formatdate-time
start: Union[str, datetime]
formatdate-time
inclusive_end: Optional[bool]
inclusive_start: Optional[bool]
subscription_input: ItemSubscriptionInput

The subscription input for the subscription timeline item.

fixed_rate_quantities: Dict[str, Union[float, str]]

The quantities of the fixed rates to use for the subscription timeline item.

Accepts one of the following:
float
str
rate_card_id: str

The ID of the rate card to use for the subscription timeline item.

rate_price_multipliers: Dict[str, Union[float, str]]

The price multipliers to use for the subscription timeline item.

Accepts one of the following:
float
str
ReturnsExpand Collapse
List[ItemCreateResponseItem]
id: str
created_at: datetime
formatdate-time
period: ItemCreateResponseItemPeriod
end: Optional[datetime]
formatdate-time
start: datetime
formatdate-time
inclusive_end: Optional[bool]
inclusive_start: Optional[bool]
subscription_input: ItemCreateResponseItemSubscriptionInput
fixed_rate_quantities: Dict[str, str]
rate_card_id: str
rate_price_multipliers: Dict[str, str]
subscription_timeline_id: str
updated_at: datetime
formatdate-time
Create Subscription Timeline Items
import os
from datetime import datetime
from lark import Lark

client = Lark(
    api_key=os.environ.get("LARK_API_KEY"),  # This is the default and can be omitted
)
items = client.subscription_timelines.items.create(
    subscription_timeline_id="subscription_timeline_id",
    items=[{
        "period": {
            "end": datetime.fromisoformat("2019-12-27T18:11:19.117"),
            "start": datetime.fromisoformat("2019-12-27T18:11:19.117"),
        },
        "subscription_input": {
            "fixed_rate_quantities": {
                "foo": 0
            },
            "rate_card_id": "rate_card_id",
            "rate_price_multipliers": {
                "foo": 0
            },
        },
    }],
)
print(items)
[
  {
    "id": "id",
    "created_at": "2019-12-27T18:11:19.117Z",
    "period": {
      "end": "2019-12-27T18:11:19.117Z",
      "start": "2019-12-27T18:11:19.117Z",
      "inclusive_end": true,
      "inclusive_start": true
    },
    "subscription_input": {
      "fixed_rate_quantities": {
        "foo": "string"
      },
      "rate_card_id": "rate_card_id",
      "rate_price_multipliers": {
        "foo": "string"
      }
    },
    "subscription_timeline_id": "subscription_timeline_id",
    "updated_at": "2019-12-27T18:11:19.117Z"
  }
]
Returns Examples
[
  {
    "id": "id",
    "created_at": "2019-12-27T18:11:19.117Z",
    "period": {
      "end": "2019-12-27T18:11:19.117Z",
      "start": "2019-12-27T18:11:19.117Z",
      "inclusive_end": true,
      "inclusive_start": true
    },
    "subscription_input": {
      "fixed_rate_quantities": {
        "foo": "string"
      },
      "rate_card_id": "rate_card_id",
      "rate_price_multipliers": {
        "foo": "string"
      }
    },
    "subscription_timeline_id": "subscription_timeline_id",
    "updated_at": "2019-12-27T18:11:19.117Z"
  }
]