v1

latestOpenAPI 3.0.02026-07-1491520.4 KB

Subaccount Management

Modify a subaccount

Change one or more properties of a subaccount.

patch/{api_key}/subaccounts/{subaccount_key}

Path parameters

api_keystring required

ID of the primary account

subaccount_keystring required

ID of the subaccount

Request body

namestring

suspendedboolean

use_primary_account_balanceboolean

Example request

{
  "name": "Subaccount department B",
  "suspended": true
}

Response

Subaccount response

api_keystring

Unique subaccount ID.

balancenumber

Balance of the subAccount. Value is null if balance is shared with primary account.

created_atstring

Subaccount creation date and time.

credit_limitnumber

Credit limit of the subAccount. Value is null if balance is shared with primary account.

namestring

Name of the subaccount.

primary_account_api_keystring

Unique primary account ID.

suspendedboolean

Subaccount suspension status.

use_primary_account_balanceboolean

Flag showing if balance is shared with primary account.

Example response

{
  "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
}