Get the account
The account this API key belongs to, with its environment, the product lines it can order and its wallet.
apiKeyAuthorizationBearer <token>An API key from the Developers page. rhq_test_ keys reach the sandbox, rhq_live_ keys the live side.
Success
application/json- response
Success
id*stringname*stringslug*stringstatus*string"active""suspended"environment*stringSandbox accounts use a test provider and test funds
"live""sandbox"sandbox*booleanShorthand for environment === "sandbox"
isSubReseller*booleanWhether this account is itself a sub-reseller, invited by another
hasSubResellers*booleanWhether this account has a sub-reseller of its own, or an invitation out to one
products*Which product lines this account can order in its environment
productRequests*When this account asked for each product line to be switched on, or null if it never has
wallet*walletTopUps*Card top-ups through Stripe (issue #335). Sandbox accounts never reach Stripe
billing*How you are identified on invoices, and the defaults for a new one
domains*portal*How your customer portal and storefront look, and what your customers may do there
portalDraft*The portal builder’s own draft: what Publish will copy onto your live portal. Edited by PATCH /account/portal/draft, and only ever reaches customers once you publish it
analytics*member*|The signed-in colleague's role and what it allows, for the dashboard to gate its navigation on the same matrix the API enforces. null for an API key, which belongs to the account rather than to a person
curl -X GET "https://example.com/v1/account"{ "id": "rsl_01K6XJ4Q8ZT3M9R5V2B7WDHNCA", "name": "Northwind Telecom", "slug": "northwind", "status": "active", "environment": "sandbox", "sandbox": true, "isSubReseller": true, "hasSubResellers": true, "products": { "numbers": true, "domains": true, "licences": true }, "productRequests": { "numbers": null, "domains": null, "licences": null }, "wallet": { "available": 8800, "held": 0, "currency": "USD" }, "walletTopUps": { "enabled": true, "min": 500, "max": 500000 }, "billing": { "legalName": "Northwind Telecom Ltd", "addressLines": [ "1 Market Street", "San Francisco, CA 94105" ], "address": { "line1": "1 Market Street", "line2": "Suite 400", "city": "San Francisco", "postalCode": "94105" }, "taxId": "12-3456789", "billingEmail": "[email protected]", "defaultDueDays": 14, "defaultTaxBps": 2000, "invoiceNote": "Thank you for your business", "country": null, "region": null, "actor": { "kind": "user", "label": "string" } }, "domains": { "defaultRegistrant": { "name": "Jo Bloggs", "organization": "Northwind Telecom", "email": "[email protected]", "phone": "+1 415 555 0132", "address": "1 Market Street", "city": "San Francisco", "state": "CA", "postalCode": "94105", "country": "US", "validation": "pending" }, "privacyByDefault": true, "autoRenewByDefault": true, "digestEnabled": true, "actor": { "kind": "user", "label": "string" } }, "portal": { "enabled": true, "brandName": "Northwind", "logoUrl": "https://northwind.example/logo.svg", "logoDarkUrl": "https://northwind.example/logo-white.svg", "accentColor": "#1d4ed8", "supportEmail": "[email protected]", "emailFromName": "Northwind Support", "termsUrl": "https://northwind.example/terms", "privacyUrl": "https://northwind.example/privacy", "selfSignup": true, "allow": [ "domains.nameservers" ], "products": [ "domains" ], "theme": "light", "fontPair": "geist", "headline": "Find your domain", "intro": "Search a name across every ending we sell.", "banner": "string", "productOrder": [ "domains" ], "termsMode": "link", "termsText": "string", "privacyMode": "link", "privacyText": "string", "faq": [ { "question": "string", "answer": "string" } ], "pricesBeforeSignIn": true, "requireEmailVerification": true, "url": "https://northwind.portal.example", "publishedAt": null }, "portalDraft": { "enabled": true, "brandName": "Northwind", "logoUrl": "https://northwind.example/logo.svg", "logoDarkUrl": "https://northwind.example/logo-white.svg", "accentColor": "#1d4ed8", "supportEmail": "[email protected]", "emailFromName": "Northwind Support", "termsUrl": "https://northwind.example/terms", "privacyUrl": "https://northwind.example/privacy", "selfSignup": true, "allow": [ "domains.nameservers" ], "products": [ "domains" ], "theme": "light", "fontPair": "geist", "headline": "Find your domain", "intro": "Search a name across every ending we sell.", "banner": "string", "productOrder": [ "domains" ], "termsMode": "link", "termsText": "string", "privacyMode": "link", "privacyText": "string", "faq": [ { "question": "string", "answer": "string" } ], "pricesBeforeSignIn": true, "requireEmailVerification": true }, "analytics": { "replayEnabled": true }, "member": { "role": "admin", "permissions": [ "account.read" ] }}API reference
Every route of the ResellerHQ REST API, with its parameters, responses and errors.
Update billing details PATCH
How your account is identified on invoices, and the defaults a new invoice falls back to when `dueInDays`, `taxBps` or `note` is not given. Send only what changes; `null` clears a field. Live and sandbox keep their own.