Account

The account resource holds your organization name, credit balance (credits_balance), monthly spend cap (spend_cap_cents), and refill reminder settings (auto_refill_threshold, auto_refill_pack_id). GET returns it; PATCH accepts any subset of organization_name, spend_cap_cents, auto_refill_threshold, and auto_refill_pack_id, and leaves the other fields unchanged. See Credit model for what the spend cap and refill reminder do.

The post operation below creates the account the first time you open the Console. It accepts only a signed-in Console session, not an API key, so programmatic integrations do not call it.

GET and PATCH responses include can_buy_credits for the member's payer status, can_verify_credit_payments for access to payment verification, and credit_checkout_enabled for purchase availability. Buying credits requires all three. Verification remains available to an authorized payer while purchases are paused. credits_buyer_name names the payer when someone else views the account. Account creation returns the account itself; opening the Console then reads the member's capabilities through GET.

curl -X GET "https://api.surfacedby.com/api/v1/console/account" \
  -H "X-API-Key: string"

null

curl -X PATCH "https://api.surfacedby.com/api/v1/console/account" \
  -H "X-API-Key: string" \
  -H "Content-Type: application/json" \
  -d '{}'

null

curl -X POST "https://api.surfacedby.com/api/v1/console/account" \
  -H "Content-Type: application/json" \
  -d '{}'

null