Create Subscription Timeline

client.subscriptionTimelines.create(, ?): SubscriptionTimelineCreateResponse { id, created_at, rate_card_id, 4 more }

post/subscription-timelines

ParametersExpand Collapse

body: SubscriptionTimelineCreateParams { rate_card_id, subject_id }

rate_card_id: string

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

subject_id: string

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

ReturnsExpand Collapse

SubscriptionTimelineCreateResponse { id, created_at, rate_card_id, 4 more }

id: string

created_at: string

formatdate-time

rate_card_id: string

status: "draft" | "pending" | "active" | "completed"

Accepts one of the following:

"draft"

"pending"

"active"

"completed"

subject_id: string

subscription_id: string | null

updated_at: string

formatdate-time

Create Subscription Timeline

import Lark from 'lark-billing';

const client = new Lark({
  apiKey: process.env['LARK_API_KEY'], // This is the default and can be omitted
});

const subscriptionTimeline = await client.subscriptionTimelines.create({
  rate_card_id: 'rate_card_id',
  subject_id: 'subject_id',
});

console.log(subscriptionTimeline.id);

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

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