Skip to content
Lark
Book a demoContact usGet started
API Reference

Subscription Timelines

List Subscription Timelines
client.subscriptionTimelines.list(SubscriptionTimelineListParams { limit, offset } query?, RequestOptionsoptions?): SubscriptionTimelineListResponse { has_more, subscription_timelines }
get/subscription-timelines
Create Subscription Timeline
client.subscriptionTimelines.create(SubscriptionTimelineCreateParams { rate_card_id, subject_id } body, RequestOptionsoptions?): SubscriptionTimelineCreateResponse { id, created_at, rate_card_id, 4 more }
post/subscription-timelines
Get Subscription Timeline
client.subscriptionTimelines.retrieve(stringsubscriptionTimelineID, RequestOptionsoptions?): SubscriptionTimelineRetrieveResponse { id, created_at, rate_card_id, 4 more }
get/subscription-timelines/{subscription_timeline_id}
Start Subscription Timeline
client.subscriptionTimelines.start(stringsubscriptionTimelineID, SubscriptionTimelineStartParams { checkout_callback_urls, create_checkout_session, effective_at } body, RequestOptionsoptions?): SubscriptionTimelineStartResponse { result }
post/subscription-timelines/{subscription_timeline_id}/start

Subscription TimelinesItems

List Subscription Timeline Items
client.subscriptionTimelines.items.list(stringsubscriptionTimelineID, ItemListParams { limit, offset } query?, RequestOptionsoptions?): ItemListResponse { has_more, items }
get/subscription-timelines/{subscription_timeline_id}/items
Create Subscription Timeline Items
client.subscriptionTimelines.items.create(stringsubscriptionTimelineID, ItemCreateParams { items } body, RequestOptionsoptions?): ItemCreateResponse { id, created_at, period, 3 more }
post/subscription-timelines/{subscription_timeline_id}/items