Billing

Use the billing resource for plan retrieval and billing lifecycle actions. Direct actions (handled locally): all, get, create, update, delete, calls, phones Stripe-delegated actions (proxied to stripe-handler): checkout, billing-portal, update-subscription, sync, check-status, purchase-calls, cancel-calls, add-phone-number, remove-phone-number

The previously documented plan, usage, and invoices action names do not exist — use get and all to retrieve billing data.

Get phone billing

Returns the caller’s phone-number subscription records and the numbers Help Genie bought for their genies, each with its billing status.

string

required

Must be "billing"

string

required

Must be "phones"

boolean

default:"false"

Admin only. When true, allows viewing another user’s phone billing with userId. Query parameter only.

string

Admin only, requires adminMode=true. Return phone billing for this user ID. Query parameter only.

Response

boolean

object

Show properties

object[]

Phone subscription records, newest first. Each record includes agents: { name } — the name of the genie the number belongs to.

object[]

Numbers Help Genie bought for the user’s genies, newest first. Transfer, escalation and ported numbers are not included.

Show properties

number

string

Provider ID of the number.

string

string | null

string

ID of the genie the number is assigned to.

string | null

string

One of:

"billed" — the number has a live phone subscription.
"no_charge_admin" — internal admin account; not charged.
"no_charge_trial" — account has no paid plan (for example, still on a trial); not charged.
"unbilled" — a paying, non-admin account with no phone subscription for this number, usually because it was added during a trial.

const response = await ApiService.invoke<{
  phoneSubscriptions: PhoneSubscription[];
  numbers: GeniePhoneNumber[];
}>({
  resource: "billing",
  action: "phones",
});

curl -X POST https://api.helpgenie.ai/v1/billing \
  -H "Authorization: Bearer hg_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "action": "phones"
  }'

Overview

Public (unauthenticated)

Agents

Knowledge

CRM

Marketplace

Platform

Telephony

Worker genies

Quality & Compliance

Access Control

Intelligence

Education

Voice

Integrations

Expanded Platform

Get phone billing

Response

​Get phone billing

​Response

Get phone billing

Response