API Reference

Subscription Timelines

Items

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List Subscription Timeline Items

subscription_timelines.items.list(strsubscription_timeline_id, ItemListParams**kwargs) -> ItemListResponse

get/subscription-timelines/{subscription_timeline_id}/items

List Subscription Timeline Items

ParametersExpand Collapse

subscription_timeline_id: str

limit: Optional[int]

maximum100

minimum1

offset: Optional[int]

minimum0

ReturnsExpand Collapse

class ItemListResponse: …

has_more: bool

items: List[Item]

id: str

created_at: datetime

formatdate-time

period: ItemPeriod

end: Optional[datetime]

formatdate-time

start: datetime

formatdate-time

inclusive_end: Optional[bool]

inclusive_start: Optional[bool]

subscription_input: ItemSubscriptionInput

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

List Subscription Timeline Items

Python

HTTP

TypeScript

Python

Go

Terraform

import os
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.list(
    subscription_timeline_id="subscription_timeline_id",
)
print(items.has_more)

200 example

{
  "has_more": true,
  "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

200 example

{
  "has_more": true,
  "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"
    }
  ]
}