List Subscriptions

get/subscriptions

List Subscriptions

Query ParametersExpand Collapse

limit: optional number

maximum100

minimum1

offset: optional number

minimum0

rate_card_id: optional string

The ID of the rate card to list subscriptions for. Cannot be used with subject_id.

subject_id: optional string

The ID or external ID of the subject to list subscriptions for. Cannot be used with rate_card_id.

ReturnsExpand Collapse

has_more: boolean

subscriptions: array of SubscriptionResource { id, cancels_at_end_of_cycle, current_period, 6 more }

id: string

The ID of the subscription.

cancels_at_end_of_cycle: boolean

Whether the subscription will be cancelled at the end of the current cycle.

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

The current period of the subscription if it is active.

end: string

formatdate-time

start: string

formatdate-time

inclusive_end: optional boolean

inclusive_start: optional boolean

cycles_next_at: string

The date and time the next cycle of the subscription will start.

formatdate-time

effective_at: string

The date and time the subscription became effective.

formatdate-time

metadata: map[string]

rate_card_id: string

The ID of the rate card of the subscription.

status: "active" or "cancelled" or "paused"

The status of the subscription.

Accepts one of the following:

"active"

"cancelled"

"paused"

subject_id: string

The ID of the subject that the subscription is for.

List Subscriptions

curl https://api.uselark.ai/subscriptions \
    -H "X-API-Key: $LARK_API_KEY"

{
  "has_more": true,
  "subscriptions": [
    {
      "id": "rc_sub_PuLvkNSP3IBCvjayBD3TXNQ6",
      "cancels_at_end_of_cycle": false,
      "current_period": {
        "end": "2025-11-01T00:00:00Z",
        "start": "2025-10-01T00:00:00Z",
        "inclusive_end": false,
        "inclusive_start": true
      },
      "cycles_next_at": "2025-11-01T00:00:00Z",
      "effective_at": "2025-10-01T00:00:00Z",
      "metadata": {},
      "rate_card_id": "rc_jQK2n0wutCj6bBcAIrL6o07g",
      "status": "active",
      "subject_id": "subj_VyX6Q96h5avMho8O7QWlKeXE"
    }
  ]
}

Returns Examples

{
  "has_more": true,
  "subscriptions": [
    {
      "id": "rc_sub_PuLvkNSP3IBCvjayBD3TXNQ6",
      "cancels_at_end_of_cycle": false,
      "current_period": {
        "end": "2025-11-01T00:00:00Z",
        "start": "2025-10-01T00:00:00Z",
        "inclusive_end": false,
        "inclusive_start": true
      },
      "cycles_next_at": "2025-11-01T00:00:00Z",
      "effective_at": "2025-10-01T00:00:00Z",
      "metadata": {},
      "rate_card_id": "rc_jQK2n0wutCj6bBcAIrL6o07g",
      "status": "active",
      "subject_id": "subj_VyX6Q96h5avMho8O7QWlKeXE"
    }
  ]
}