clerk.cancel_billing_subscription_item
ActiveTool of Vee3
declared in 1.27.1
Cancel a billing subscription item in a connected Clerk application. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the updated subscription_item summary. Cost = 8 tokens.
Parameters schema
{
"type": "object",
"title": "cancel_clerk_billing_subscription_itemArguments",
"required": [
"subscription_item_id"
],
"properties": {
"end_now": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "End Now",
"default": null,
"description": "When true, end the subscription immediately instead of at period end."
},
"clerk_instance_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Clerk Instance Id",
"default": null,
"description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account."
},
"subscription_item_id": {
"type": "string",
"title": "Subscription Item Id",
"description": "Clerk billing subscription item id."
}
}
}Parent server
Vee3
https://github.com/Vee3io/Vee3
1/7 registries