Cancel Subscription

subscriptions.cancel(, ) -> SubscriptionResource

post/subscriptions/{subscription_id}/cancel

Cancel Subscription

ParametersExpand Collapse

subscription_id: str

cancel_at_end_of_cycle: Optional[Literal[true]]

Whether to cancel the subscription at end of cycle.

reason: Optional[str]

The reason for cancelling the subscription.

ReturnsExpand Collapse

class SubscriptionResource: …

id: str

The ID of the subscription.

cancels_at_end_of_cycle: bool

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

current_period: Optional[CurrentPeriod]

The current period of the subscription if it is active.

end: datetime

formatdate-time

start: datetime

formatdate-time

inclusive_end: Optional[bool]

inclusive_start: Optional[bool]

cycles_next_at: Optional[datetime]

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

formatdate-time

effective_at: datetime

The date and time the subscription became effective.

formatdate-time

fixed_rate_quantities: Dict[str, str]

The quantities of the fixed rates of the subscription.

metadata: Dict[str, str]

rate_card_id: str

The ID of the rate card of the subscription.

rate_price_multipliers: Dict[str, str]

The price multipliers of the rates of the subscription.

status: Literal["active", "cancelled", "paused"]

The status of the subscription.

Accepts one of the following:

"active"

"cancelled"

"paused"

subject_id: str

The ID of the subject that the subscription is for.

Cancel Subscription

import os
from lark import Lark

client = Lark(
    api_key=os.environ.get("LARK_API_KEY"),  # This is the default and can be omitted
)
subscription_resource = client.subscriptions.cancel(
    subscription_id="subscription_id",
    cancel_at_end_of_cycle=True,
)
print(subscription_resource.id)

{
  "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",
  "fixed_rate_quantities": {
    "base_rate": "1"
  },
  "metadata": {},
  "rate_card_id": "rc_jQK2n0wutCj6bBcAIrL6o07g",
  "rate_price_multipliers": {},
  "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",
  "fixed_rate_quantities": {
    "base_rate": "1"
  },
  "metadata": {},
  "rate_card_id": "rc_jQK2n0wutCj6bBcAIrL6o07g",
  "rate_price_multipliers": {},
  "status": "active",
  "subject_id": "subj_VyX6Q96h5avMho8O7QWlKeXE"
}