List Subscription Timelines

get/subscription-timelines

Query ParametersExpand Collapse

limit: optional number

maximum100

minimum1

offset: optional number

minimum0

ReturnsExpand Collapse

has_more: boolean

subscription_timelines: array of object { id, created_at, rate_card_id, 4 more }

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

List Subscription Timelines

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

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