v1

latestOpenAPI 3.0.02026-07-1491520.4 KB
Subaccount Management

Retrieve list of subaccounts

Get the information of all the subaccounts owned by the primary account.

get/{api_key}/subaccounts

Path parameters

api_keystring required

ID of the primary account

Response

Subaccounts response

Example response

{
  "_embedded": {
    "primary_account": {
      "api_key": "bbe6222f",
      "balance": 100.25,
      "created_at": "2018-03-02T16:34:49Z",
      "credit_limit": -100.25,
      "name": "Subaccount department A",
      "primary_account_api_key": "acc6111f",
      "use_primary_account_balance": true
    },
    "subaccounts": [
      {
        "api_key": "bbe6222f",
        "balance": 100.25,
        "created_at": "2018-03-02T16:34:49Z",
        "credit_limit": -100.25,
        "name": "Subaccount department A",
        "primary_account_api_key": "acc6111f",
        "use_primary_account_balance": true
      }
    ]
  }
}