get_credits
The account's balance, as the web app's wallet shows it: what is left, the plan, and who pays for the next study. For a member of an organization that pays for its studies, also the organization's credits left this month. Free. Use it before a large study, or after an insufficient_funds error.
Returns: { unit, balance_credits, credits_expiring (credits that will expire, soonest first), plan, billed_to ('wallet' | 'org'), billed_org_name, organization (its credits this month: included, used, remaining, level), spend_paused, payment_overdue, card_required, credit_line_reached, weekly_free (Free plan: the weekly credits and when they reset), plan_unpaid, top_up_url }. payment_overdue is present when the organization that pays has an overdue invoice: { state ('scheduled' | 'paused'), pause_at, can_pay }. card_required is present when that organization has no card on file and its agreement requires one: { state, pause_at }. credit_line_reached is present when that organization is paused at its credit line: { state, reason }. While scheduled, studies run until pause_at; tell the user an org admin should pay, or save a card, in the organization portal.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||