Cancel Subscription

post/subscriptions/{subscription_id}/cancel

Cancel Subscription

Path ParametersExpand Collapse

subscription_id: string

Body ParametersExpand Collapse

cancel_at_end_of_cycle: optional true

Whether to cancel the subscription at end of cycle.

Accepts one of the following:

true

reason: optional string

The reason for cancelling the subscription.

ReturnsExpand Collapse

SubscriptionResource = object { 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.

Cancel Subscription

curl https://api.uselark.ai/subscriptions/$SUBSCRIPTION_ID/cancel \
    -H 'Content-Type: application/json' \
    -H "X-API-Key: $LARK_API_KEY" \
    -d '{}'

{
  "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

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