List Subscription Timeline Items

get/subscription-timelines/{subscription_timeline_id}/items

Path ParametersExpand Collapse

subscription_timeline_id: string

Query ParametersExpand Collapse

limit: optional number

maximum100

minimum1

offset: optional number

minimum0

ReturnsExpand Collapse

has_more: boolean

items: array of object { id, created_at, period, 3 more }

id: string

created_at: string

formatdate-time

period: object { end, start, inclusive_end, inclusive_start }

end: string

formatdate-time

start: string

formatdate-time

inclusive_end: optional boolean

inclusive_start: optional boolean

subscription_input: object { fixed_rate_quantities, rate_card_id, rate_price_multipliers }

fixed_rate_quantities: map[string]

rate_card_id: string

rate_price_multipliers: map[string]

subscription_timeline_id: string

updated_at: string

formatdate-time

List Subscription Timeline Items

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

{
  "has_more": true,
  "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

{
  "has_more": true,
  "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"
    }
  ]
}