Methods
Objects
Manage Sub Accounts.
| Method | Description |
|---|---|
| account/sub.archive | Archive a disabled Sub Account. The method is asynchronous. You can us... |
| account/sub.create | Create a Sub Account. |
| account/sub.disable | Disable an enabled Sub Account. |
| account/sub.edit | Edit a Sub Account. |
| account/sub.enable | Enable a desactivated an not archived Sub Account. |
| account/sub.get | Get informations on a Sub Account. |
| account/sub.get_quota | Get quota informations from the Master Account. |
| account/sub.search | Search through Sub Accounts. |
| account/sub.transfer_credit | Tranfer credit from/to a Sub Account to another one or the Master Acco... |
| account/sub.transfer_dids | Tranfer dids from/to a Sub Account to another one or the Master Accoun... |
| account/sub.unarchive | Unarchive an archived Sub Account (and keep it disabled). |
account/sub.archive
Archive a disabled Sub Account. The method is asynchronous. You can use "jobs.get" to check the status of the job. Or use a Webhook on "job.status_update".
method: account/sub.archive
params: [string id, object options]
| Parameter | Type | Description | NULL |
|---|---|---|---|
| id | string |
Sub Account ID Format: hash (Unique object identifier) |
NO |
| options | object | Reserved for future use | YES |
| Type | Description | Format/Object |
|---|---|---|
| string | Job ID | Format: hid (Unique object identifier) |
account/sub.create
Create a Sub Account.
method: account/sub.create
params: [object properties, object options]
| Parameter | Type | Description | NULL |
|---|---|---|---|
| properties | object |
Object properties Object: SubAccount.CreateProperties |
NO |
| options | object |
Object options Object: SubAccount.CreateOptions |
NO |
| Type | Description | Format/Object |
|---|---|---|
| object | SubAccount The created Sub Account | Object: SubAccount |
account/sub.disable
Disable an enabled Sub Account.
method: account/sub.disable
params: [string id]
| Parameter | Type | Description | NULL |
|---|---|---|---|
| id | string |
Sub Account ID Format: hash (Unique object identifier) |
NO |
| Type | Description | Format/Object |
|---|---|---|
| bool | Always TRUE (throws an Exception otherwise). |
account/sub.edit
Edit a Sub Account.
method: account/sub.edit
params: [string id, object properties, object options]
| Parameter | Type | Description | NULL |
|---|---|---|---|
| id | string |
Sub Account ID Format: hash (Unique object identifier) |
NO |
| properties | object |
Object properties Object: SubAccount.EditProperties |
NO |
| options | object |
Object options Object: SubAccount.EditOptions |
NO |
| Type | Description | Format/Object |
|---|---|---|
| object | SubAccount Object | Object: SubAccount |
account/sub.enable
Enable a desactivated an not archived Sub Account.
method: account/sub.enable
params: [string id]
| Parameter | Type | Description | NULL |
|---|---|---|---|
| id | string |
Sub Account ID Format: hash (Unique object identifier) |
NO |
| Type | Description | Format/Object |
|---|---|---|
| bool | Always TRUE (throws an Exception otherwise). |
account/sub.get
Get informations on a Sub Account.
method: account/sub.get
params: [string id]
| Parameter | Type | Description | NULL |
|---|---|---|---|
| id | string |
Sub Account ID Format: hash (Unique object identifier) |
NO |
| Type | Description | Format/Object |
|---|---|---|
| object | SubAccount Object | Object: SubAccount |
account/sub.get_quota
Get quota informations from the Master Account.
method: account/sub.get_quota
params: []
No parameters.
| Type | Description | Format/Object |
|---|---|---|
| object | Quota informations | Object: SubAccount.Quota |
account/sub.search
Search through Sub Accounts.
method: account/sub.search
params: [object filters, object options]
| Parameter | Type | Description | NULL |
|---|---|---|---|
| filters | object |
Search filters Object: SubAccount.SearchFilters |
NO |
| options | object |
Search options Object: Search.Options |
NO |
| Type | Description | Format/Object |
|---|---|---|
| object | Search results | Object: Search.Results |
account/sub.transfer_credit
Tranfer credit from/to a Sub Account to another one or the Master Account.
method: account/sub.transfer_credit
params: [string from_id, string to_id, string amount, object options]
| Parameter | Type | Description | NULL |
|---|---|---|---|
| from_id | string |
From Account ID Format: hash (Unique object identifier) |
NO |
| to_id | string |
To another Account ID Format: hash (Unique object identifier) |
NO |
| amount | string |
The amount of credit Format: amount (amount in cents with 2 decimals. Example : "1000.00" for 10 USD or EUR) |
NO |
| options | object |
Object options Object: SubAccount.TransferOptions |
NO |
| Type | Description | Format/Object |
|---|---|---|
| bool | Always TRUE (throws an Exception otherwise). |
account/sub.transfer_dids
Tranfer dids from/to a Sub Account to another one or the Master Account.
method: account/sub.transfer_dids
params: [string from_id, string to_id, array dids]
| Parameter | Type | Description | NULL |
|---|---|---|---|
| from_id | string |
From Account ID Format: hash (Unique object identifier) |
NO |
| to_id | string |
To another Account ID Format: hash (Unique object identifier) |
NO |
| dids | array |
Multiple DIDs to transfer Format: hash (Unique object identifier) |
NO |
| Type | Description | Format/Object |
|---|---|---|
| bool | Always TRUE (throws an Exception otherwise). |
account/sub.unarchive
Unarchive an archived Sub Account (and keep it disabled).
method: account/sub.unarchive
params: [string id]
| Parameter | Type | Description | NULL |
|---|---|---|---|
| id | string |
Sub Account ID Format: hash (Unique object identifier) |
NO |
| Type | Description | Format/Object |
|---|---|---|
| bool | Always TRUE (throws an Exception otherwise). |