Create Subscription Timeline Items

post/subscription-timelines/{subscription_timeline_id}/items

Path ParametersExpand Collapse

subscription_timeline_id: string

Body ParametersExpand Collapse

items: array of object { period, subscription_input }

The items to create for the subscription timeline.

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

The period of the subscription timeline item.

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 }

The subscription input for the subscription timeline item.

fixed_rate_quantities: map[number or string]

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

Accepts one of the following:

UnionMember0 = number

UnionMember1 = string

rate_card_id: string

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

rate_price_multipliers: map[number or string]

The price multipliers to use for the subscription timeline item.

Accepts one of the following:

UnionMember0 = number

UnionMember1 = string

ReturnsExpand Collapse

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

Create Subscription Timeline Items

curl https://api.uselark.ai/subscription-timelines/$SUBSCRIPTION_TIMELINE_ID/items \
    -H 'Content-Type: application/json' \
    -H "X-API-Key: $LARK_API_KEY" \
    -d '{
          "items": [
            {
              "period": {
                "end": "2019-12-27T18:11:19.117Z",
                "start": "2019-12-27T18:11:19.117Z"
              },
              "subscription_input": {
                "fixed_rate_quantities": {
                  "foo": 0
                },
                "rate_card_id": "rate_card_id",
                "rate_price_multipliers": {
                  "foo": 0
                }
              }
            }
          ]
        }'

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