API Reference

Subscription Timelines

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Create Subscription Timeline

subscription_timelines.create(SubscriptionTimelineCreateParams**kwargs) -> SubscriptionTimelineCreateResponse

post/subscription-timelines

Create Subscription Timeline

ParametersExpand Collapse

rate_card_id: str

The ID of the rate card to create the subscription timeline for.

subject_id: str

The ID of the subject to create the subscription timeline for.

ReturnsExpand Collapse

class SubscriptionTimelineCreateResponse: …

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

Create Subscription Timeline

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
)
subscription_timeline = client.subscription_timelines.create(
    rate_card_id="rate_card_id",
    subject_id="subject_id",
)
print(subscription_timeline.id)

200 example

{
  "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

200 example

{
  "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"
}