account::get

1. Index
2. > Function reference
3. > account::get

Description

Get summary details (email address, balance, status) for an account

Request details

• Method

  GET

• URL

  https://api.hostingreborn.com/account/get/

Arguments

key

API key

Responses

<?xml version="1.0" encoding="utf-8"?>
<account>
  <email>user1@example.com</email>
  <status>active</status>
  <balance>987.718247423</balance>
</account>

<?xml version="1.0" encoding="utf-8"?>
<account>
  <email>user2@example.com</email>
  <status>suspended</status>
  <suspensionreason>overdrawn</suspensionreason>
  <balance>987.718247423</balance>
</account>
	

email

Account email address

status

active

Account is active, all ok

incomplete

Account created, but email address not verified

pending

Account created, email address verified, awaiting activation

suspended

Account suspended

cancelled

Account is no more

suspensionreason (only present if status=suspended)

overdrawn

Suspended as the account balance is zero or less

breach

Suspended for a breach of the terms of service

balance

Current balance in pence

Exceptions

• database

• access

Examples

Get active account

GET /account/get/?key=acbd18db4cc2f85cedef654fccc4a4d8

<?xml version="1.0" encoding="utf-8"?>
<account>
  <email>user1@example.com</email>
  <status>active</status>
  <balance>987.718247423</balance>
</account>
	

Get suspended account

GET /account/get/?key=acbd18db4cc2f85cedef654fccc4a4d8

<?xml version="1.0" encoding="utf-8"?>
<account>
  <email>user1@example.com</email>
  <status>suspended</status>
  <suspensionreason>overdrawn</suspensionreason>
  <balance>987.718247423</balance>
</account>
	

See also

• account::get_balance

  Get account balance at any time