clerk.adjust_organization_billing_credit_balance
ActiveTool of Vee3
declared in 1.27.1
Increase or decrease billing credit for a Clerk organization 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 credit_ledger summary. Cost = 8 tokens.
Parameters schema
{
"type": "object",
"title": "adjust_clerk_organization_billing_credit_balanceArguments",
"required": [
"organization_id",
"amount",
"action",
"idempotency_key"
],
"properties": {
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Note",
"default": null,
"description": "Optional note describing the credit adjustment."
},
"action": {
"type": "string",
"title": "Action",
"description": "Credit adjustment action: \"increase\" or \"decrease\"."
},
"amount": {
"type": "integer",
"title": "Amount",
"minimum": 1,
"description": "Credit adjustment amount in cents (minimum 1)."
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"default": null,
"description": "ISO currency code for the credit adjustment."
},
"idempotency_key": {
"type": "string",
"title": "Idempotency Key",
"description": "Unique key to make the credit adjustment idempotent."
},
"organization_id": {
"type": "string",
"title": "Organization Id",
"description": "Clerk organization id (org_...) to operate on."
},
"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."
}
}
}Parent server
Vee3
https://github.com/Vee3io/Vee3
1/7 registries