API Reference

Subscription Timelines

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Create Subscription Timeline

client.SubscriptionTimelines.New(ctx, body) (*SubscriptionTimelineNewResponse, error)

post/subscription-timelines

Create Subscription Timeline

ParametersExpand Collapse

body SubscriptionTimelineNewParams

RateCardID param.Field[string]

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

SubjectID param.Field[string]

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

ReturnsExpand Collapse

type SubscriptionTimelineNewResponse struct{…}

ID string

CreatedAt Time

formatdate-time

RateCardID string

Status SubscriptionTimelineNewResponseStatus

Accepts one of the following:

const SubscriptionTimelineNewResponseStatusDraft SubscriptionTimelineNewResponseStatus = "draft"

const SubscriptionTimelineNewResponseStatusPending SubscriptionTimelineNewResponseStatus = "pending"

const SubscriptionTimelineNewResponseStatusActive SubscriptionTimelineNewResponseStatus = "active"

const SubscriptionTimelineNewResponseStatusCompleted SubscriptionTimelineNewResponseStatus = "completed"

SubjectID string

SubscriptionID string

UpdatedAt Time

formatdate-time

Create Subscription Timeline

Go

HTTP

TypeScript

Python

Go

Terraform

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/lark-go"
  "github.com/stainless-sdks/lark-go/option"
)

func main() {
  client := lark.NewClient(
    option.WithAPIKey("My API Key"),
  )
  subscriptionTimeline, err := client.SubscriptionTimelines.New(context.TODO(), lark.SubscriptionTimelineNewParams{
    RateCardID: "rate_card_id",
    SubjectID: "subject_id",
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", subscriptionTimeline.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"
}