Get merchant status
get_merchant_status[Admin] Get a merchant status snapshot: credit balances, subscription, pending-work counts, candidate/result totals, and invitation headroom.
Status snapshot for a merchant: interview-credit balances, subscription type/status, pending-work counts (undecided / ongoing / uncredited interviews), candidate & result totals with 14-day history, and invitation headroom. Scoped to your token's merchant (or a merchant_id override for admins / sub-merchant operators). Also echoes the caller's profile_id and default_merchant_id from the token, plus the effective merchant_id.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| merchant_id | No | Optional merchant to scope to. Admins and sub-merchant operators only; other callers always use their token's merchant. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| candidates | Yes | Total candidates (non-archived profile_interview rows) for the merchant. | |
| profile_id | Yes | The calling user's profile id (auth user id), taken from the JWT. | |
| merchant_id | Yes | The merchant this status is scoped to — the default_merchant_id unless an admin / sub-merchant operator overrode it via the merchant_id query param. | |
| invitations_sent | Yes | Interview invitations sent during the current subscription period. | |
| interview_results | Yes | Total non-archived interview results for the merchant. | |
| invitations_limit | Yes | Maximum invitations allowed this period (4x available credits). Null for unlimited (Special) plans. | |
| subscription_type | Yes | Subscription plan name (e.g. Free, Starter, Growth, Special). | |
| candidates_history | Yes | Daily new-candidate counts for the last 14 days, most recent first. | |
| definitions_active | Yes | Count of active interview + position definitions. | |
| interviews_ongoing | Yes | Interviews currently in progress (coach_status = started). | |
| default_merchant_id | Yes | The caller's home merchant id pinned in the JWT (app_metadata.merchant_id). Null if the token carries no merchant. | |
| subscription_status | Yes | Subscription status (e.g. active, past_due, canceled). Null when no subscription. | |
| interviews_undecided | Yes | Completed interviews awaiting a recruiter decision. | |
| invitations_available | Yes | Remaining invitations this period. Null for unlimited (Special) plans. | |
| credits_interview_extra | Yes | Extra (top-up) interview credits available on top of the monthly allowance. | |
| credits_interview_single | Yes | Single-position interview credits available. | |
| interview_result_history | Yes | Daily new-interview-result counts for the last 14 days, most recent first. | |
| credits_interview_monthly | Yes | Remaining monthly interview credits. | |
| interviews_without_credits | Yes | Completed interviews that have not yet consumed a credit. | |
| credits_interview_monthly_limit | Yes | Monthly interview-credit allowance for the current plan. |