API Reference

Subscription Timelines

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get Subscription Timeline

get/subscription-timelines/{subscription_timeline_id}

Get Subscription Timeline

Path ParametersExpand Collapse

subscription_timeline_id: string

ReturnsExpand Collapse

id: string

created_at: string

formatdate-time

rate_card_id: string

status: "draft" or "pending" or "active" or "completed"

Accepts one of the following:

"draft"

"pending"

"active"

"completed"

subject_id: string

subscription_id: string

updated_at: string

formatdate-time

Get Subscription Timeline

HTTP

HTTP

TypeScript

Python

Go

Terraform

curl https://api.uselark.ai/subscription-timelines/$SUBSCRIPTION_TIMELINE_ID \
    -H "X-API-Key: $LARK_API_KEY"

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