List Subscription Timelines

subscription_timelines.list() -> SubscriptionTimelineListResponse

get/subscription-timelines

ParametersExpand Collapse

limit: Optional[int]

maximum100

minimum1

offset: Optional[int]

minimum0

ReturnsExpand Collapse

class SubscriptionTimelineListResponse: …

has_more: bool

subscription_timelines: List[SubscriptionTimeline]

id: str

created_at: datetime

formatdate-time

rate_card_id: str

status: Literal["draft", "pending", "active", "completed"]

Accepts one of the following:

"draft"

"pending"

"active"

"completed"

subject_id: str

subscription_id: Optional[str]

updated_at: datetime

formatdate-time

List Subscription Timelines

import os
from lark import Lark

client = Lark(
    api_key=os.environ.get("LARK_API_KEY"),  # This is the default and can be omitted
)
subscription_timelines = client.subscription_timelines.list()
print(subscription_timelines.has_more)

{
  "has_more": true,
  "subscription_timelines": [
    {
      "id": "id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "rate_card_id": "rate_card_id",
      "status": "draft",
      "subject_id": "subject_id",
      "subscription_id": "subscription_id",
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ]
}

Returns Examples

{
  "has_more": true,
  "subscription_timelines": [
    {
      "id": "id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "rate_card_id": "rate_card_id",
      "status": "draft",
      "subject_id": "subject_id",
      "subscription_id": "subscription_id",
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ]
}