DocsAccount

Account

Your balance, tier and which environment a key works in. Handy as a first call to check that a key works.

The account object

Name	Type	Description
`id`	integer	Your account ID.
`object`	string	Always `account`.
`name`	string	Account name.
`email`	string	Sign-in email.
`tier`	string	Your pricing tier: `standard`, `pro`, `business` or `partner`. See pricing.
`balance`	string	Live balance in USD, or the sandbox balance when you call with a test key.
`currency`	string	Always `USD`.
`livemode`	boolean	`true` for a live key, `false` for a test key.

Get your account

GET/v1/meScope read

cURL

Request
curl https://orbismm.com/api/v1/me \
  -H "Authorization: Bearer $ORBISMM_KEY"

Response · 200 OK
{
  "id": 4182,
  "object": "account",
  "name": "Northwind Media",
  "email": "[email protected]",
  "tier": "pro",
  "balance": "231.5000",
  "currency": "USD",
  "livemode": true
}

Reset the sandbox balance

POST/v1/sandbox/resetScope read

Sets the sandbox balance back to $1,000 and returns the account. Sandbox orders are kept. Test keys only: a live key gets 403 sandbox_only. More in Sandbox.

cURL

Request
curl -X POST https://orbismm.com/api/v1/sandbox/reset \
  -H "Authorization: Bearer $ORBISMM_TEST_KEY"

Response · 200 OK
{
  "id": 4182,
  "object": "account",
  "name": "Northwind Media",
  "email": "[email protected]",
  "tier": "pro",
  "balance": "1000.0000",
  "currency": "USD",
  "livemode": false
}