Create Subscription Timeline Items

client.SubscriptionTimelines.Items.New(ctx, subscriptionTimelineID, body) (*[]SubscriptionTimelineItemNewResponse, error)

post/subscription-timelines/{subscription_timeline_id}/items

ParametersExpand Collapse

subscriptionTimelineID string

body SubscriptionTimelineItemNewParams

Items param.Field[[]SubscriptionTimelineItemNewParamsItem]

The items to create for the subscription timeline.

Period SubscriptionTimelineItemNewParamsItemPeriod

The period of the subscription timeline item.

End Time

formatdate-time

Start Time

formatdate-time

InclusiveEnd booloptional

InclusiveStart booloptional

SubscriptionInput SubscriptionTimelineItemNewParamsItemSubscriptionInput

The subscription input for the subscription timeline item.

FixedRateQuantities map[string, SubscriptionTimelineItemNewParamsItemSubscriptionInputFixedRateQuantityUnion]

The quantities of the fixed rates to use for the subscription timeline item.

Accepts one of the following:

float64

string

RateCardID string

The ID of the rate card to use for the subscription timeline item.

RatePriceMultipliers map[string, SubscriptionTimelineItemNewParamsItemSubscriptionInputRatePriceMultiplierUnion]

The price multipliers to use for the subscription timeline item.

Accepts one of the following:

float64

string

ReturnsExpand Collapse

type SubscriptionTimelineItemNewResponse []SubscriptionTimelineItemNewResponse

ID string

CreatedAt Time

formatdate-time

Period SubscriptionTimelineItemNewResponsePeriod

End Time

formatdate-time

Start Time

formatdate-time

InclusiveEnd booloptional

InclusiveStart booloptional

SubscriptionInput SubscriptionTimelineItemNewResponseSubscriptionInput

FixedRateQuantities map[string, string]

RateCardID string

RatePriceMultipliers map[string, string]

SubscriptionTimelineID string

UpdatedAt Time

formatdate-time

Create Subscription Timeline Items

package main

import (
  "context"
  "fmt"
  "time"

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

func main() {
  client := lark.NewClient(
    option.WithAPIKey("My API Key"),
  )
  items, err := client.SubscriptionTimelines.Items.New(
    context.TODO(),
    "subscription_timeline_id",
    lark.SubscriptionTimelineItemNewParams{
      Items: []lark.SubscriptionTimelineItemNewParamsItem{lark.SubscriptionTimelineItemNewParamsItem{
        Period: lark.SubscriptionTimelineItemNewParamsItemPeriod{
          End: lark.Time(time.Now()),
          Start: time.Now(),
        },
        SubscriptionInput: lark.SubscriptionTimelineItemNewParamsItemSubscriptionInput{
          FixedRateQuantities: map[string]lark.SubscriptionTimelineItemNewParamsItemSubscriptionInputFixedRateQuantityUnion{
          "foo": lark.SubscriptionTimelineItemNewParamsItemSubscriptionInputFixedRateQuantityUnion{
            OfFloat: lark.Float(0),
          },
          },
          RateCardID: "rate_card_id",
          RatePriceMultipliers: map[string]lark.SubscriptionTimelineItemNewParamsItemSubscriptionInputRatePriceMultiplierUnion{
          "foo": lark.SubscriptionTimelineItemNewParamsItemSubscriptionInputRatePriceMultiplierUnion{
            OfFloat: lark.Float(0),
          },
          },
        },
      }},
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", items)
}

[
  {
    "id": "id",
    "created_at": "2019-12-27T18:11:19.117Z",
    "period": {
      "end": "2019-12-27T18:11:19.117Z",
      "start": "2019-12-27T18:11:19.117Z",
      "inclusive_end": true,
      "inclusive_start": true
    },
    "subscription_input": {
      "fixed_rate_quantities": {
        "foo": "string"
      },
      "rate_card_id": "rate_card_id",
      "rate_price_multipliers": {
        "foo": "string"
      }
    },
    "subscription_timeline_id": "subscription_timeline_id",
    "updated_at": "2019-12-27T18:11:19.117Z"
  }
]

Returns Examples

[
  {
    "id": "id",
    "created_at": "2019-12-27T18:11:19.117Z",
    "period": {
      "end": "2019-12-27T18:11:19.117Z",
      "start": "2019-12-27T18:11:19.117Z",
      "inclusive_end": true,
      "inclusive_start": true
    },
    "subscription_input": {
      "fixed_rate_quantities": {
        "foo": "string"
      },
      "rate_card_id": "rate_card_id",
      "rate_price_multipliers": {
        "foo": "string"
      }
    },
    "subscription_timeline_id": "subscription_timeline_id",
    "updated_at": "2019-12-27T18:11:19.117Z"
  }
]