Tools · Credits

Credits through the assistant: seeing the balance and the statement (your own or, for the team, any member's), granting and adjusting credits, taking them back, and reading or changing the community rules. The credits of plans and products are set with create_plan and update_plan (monthly_credits) and create_product and update_product (granted_credits and granted_credits_validity_days); in a community with no Bookings or Scheduling space, the assistant explains that one has to be created first.

Each tool carries a badge: Read-only changes nothing, Changes creates or changes something right away, and Asks to confirm only acts after your yes to a summary. See Money and confirmation.

#In short

"Finance" here means owner, admin or finance; the moderator only reads. "Team" is the owner, the admin, the moderator and finance. The roles are the routes' roles: the assistant never does more than the connected person could do on screen. The platform variable that decides whether a paused or past-due subscription keeps using its balance belongs to the SuperAdmin and has no tool.

#get_credit_balance

Read-only

The balance. The usable balance (the sum of the batches that haven't expired; it can be negative, which blocks booking), what expires in the next 7 days and the batches, each with its source (Plan, Product or Team), how much is left and when it expires. Minimum role: any (yours); the team reads any member's.

Ask like this: "How many credits do I have?" · "What is Maria Souza's balance?"

#list_credit_entries

Read-only

The statement. Each entry with its type (grant, used on a booking, refund, adjustment, expiration, revocation), the signed amount, the source, the booking, product or subscription behind it and the reason. The ledger only grows: nothing is edited or deleted. Paginated.

Ask like this: "Show Maria's credit statement for this month."

#grant_credits

Asks to confirm

Grant credits. Opens a new batch with a required reason and an optional validity (without it, they don't expire). Before acting, it shows a summary and only repeats the call after your yes. Returns the new balance and the entry. Minimum role: finance.

Ask like this: "Give John 10 courtesy credits, valid until the end of the month, because he referred a new member."

#adjust_credits

Asks to confirm

Adjust upward. Adds credits as a correction (an adjustment entry: it's the way to fix a mistake, since the ledger never edits). Same parameters as grant_credits (up to 100,000 at a time), and it also asks to confirm. To take credits away, use revoke_credits, which asks to confirm. Minimum role: finance.

#revoke_credits

Asks to confirm

Take credits back. A negative adjustment, with a required reason. It uses the batches that expire first and doesn't go beyond the usable balance (otherwise, 409: read the balance first). Before acting, it shows a summary (how much, the balance now, the balance after and the reason) and only repeats the call with the confirmation_token after an explicit yes. Minimum role: finance.

#get_credit_settings

Read-only

The rules. Accrual (on, cap, months), first-month proration, cancellation window in hours, whether late cancellation and no-shows lose the credit, and the days of expiry notice. Minimum role: moderator (or finance).

#update_credit_settings

Changes

Change the rules. Changes only what you send. It applies from the next month turnover on and never changes a batch that already exists. Minimum role: admin.

Ask like this: "Turn on credit accrual, with a cap of 20, for 2 months, and set the cancellation window to 12 hours."

#Related

• Credits
• Tools · Bookings and Scheduling
• Tools
• Money and confirmation
• Recipes