Skip to main content
GET
Get consumer account info
Returns account details including billing status, subscription validity, and auto-renewal settings. Use Cases:
  • Check billing status and payment due dates
  • Verify subscription expiration
  • Display account summary in customer portal

Authorizations

Authorization
string
header
required

JWT token obtained from Xerobi account dashboard

Headers

Hixe-Version
string
required

API version in YYYY-MM-DD format. Current version: 2026-01-01

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-01-01"

Response

Successfully retrieved account information

Account information including billing and subscription details

plan
string
required

Current subscription plan

Example:

"Fiber 1000"

valid_until
string<date>
required

Date until which the subscription is valid (ISO 8601 format)

Example:

"2026-02-01"

billing_status
enum<string>
required

Current billing status

Available options:
paid,
unpaid,
overdue
Example:

"paid"

account_id
string

Unique account identifier

Example:

"ACC-123456"

name
string

Account holder name

Example:

"John Doe"

auto_renew
boolean

Whether auto-renewal is enabled

Example:

true

next_billing_date
string<date>

Next billing date (ISO 8601 format)

Example:

"2026-01-15"