Account
Manage Account.
Aaaa
Endpoint
POST /account/aaaa
Authorized User Role
admin
Request Body
Field | Type
- | - id | string
Response
A string.
Create
Create an account
Create an account and initial user.
Endpoint
POST /account/create
Authorized User Role
public
Request Body
Field | Type | Required
- | - | - email | string | yes name | string | yes
Response
Field | Type
- | - account | Account user | User
Account
Field | Type
- | - activity | date billing | object closed | boolean created | date email | string id | string metrics | object name | string suspended | boolean
Billing
Field | Type
- | - address | string agreement | boolean cardId | string canWire | boolean company | string country | string credit | number error | string invoiceEmail | string memo | string order | string renew | date renewing | boolean stripeId | string subject | string terms | number wire | boolean
Metrics
Field | Type
- | - agents | array balance | number connected | number clouds | number customer | boolean dashboards | number devices | number developer | number emails | object interest | array notifications | number plans | number products | number software | number support | number users | number
User
Field | Type
- | - accountId | string activity | date email | string first | string id | string invite | string last | string preferences | object role | string state | string
Close
Close account
Close an account and remove all allocated resources. This operation cannot be reversed.
Endpoint
POST /account/close
Authorized User Role
owner
Request Body
Field | Type | Role
- | - | - id | string | support
Get
Get account
Get an account given the account ID.
Endpoint
POST /account/get
Authorized User Role
user
Request Body
Field | Type
- | - id | string email | string
Query String Options
Field | Type
- | - hidden | boolean filter | string limit | number next | object prev | object index | string where | string log | boolean
Response
Field | Type
- | - activity | date billing | object closed | boolean created | date email | string id | string metrics | object name | string suspended | boolean
Billing
Field | Type
- | - address | string agreement | boolean cardId | string canWire | boolean company | string country | string credit | number error | string invoiceEmail | string memo | string order | string renew | date renewing | boolean stripeId | string subject | string terms | number wire | boolean
Metrics
Field | Type
- | - agents | array balance | number connected | number clouds | number customer | boolean dashboards | number devices | number developer | number emails | object interest | array notifications | number plans | number products | number software | number support | number users | number
GetID
Endpoint
POST /account/getID
Authorized User Role
user
Request Body
Field | Type
- | - size | number
Response
A string.
Find
Endpoint
POST /account/find
Authorized User Role
support
Request Body
Field | Type
- | - id | string email | string
Query String Options
Field | Type
- | - hidden | boolean filter | string limit | number next | object prev | object index | string where | string log | boolean
Response
Paged response.
Field | Type | Notes
- | - | - data | array | Array of items. next | string | Paged cursor to use for the next page of items. prev | string | Pages cursor to use for the previous page of items.
Account
An array of Account items.
Field | Type
- | - activity | date billing | object closed | boolean created | date email | string id | string metrics | object name | string suspended | boolean
Billing
Field | Type
- | - address | string agreement | boolean cardId | string canWire | boolean company | string country | string credit | number error | string invoiceEmail | string memo | string order | string renew | date renewing | boolean stripeId | string subject | string terms | number wire | boolean
Metrics
Field | Type
- | - agents | array balance | number connected | number clouds | number customer | boolean dashboards | number devices | number developer | number emails | object interest | array notifications | number plans | number products | number software | number support | number users | number
Init
Endpoint
POST /account/init
Authorized User Role
user
Request Body
A object.
Response
An empty account object.
Field | Type
- | - activity | date billing | object closed | boolean created | date email | string id | string metrics | object name | string suspended | boolean
Billing
Field | Type
- | - address | string agreement | boolean cardId | string canWire | boolean company | string country | string credit | number error | string invoiceEmail | string memo | string order | string renew | date renewing | boolean stripeId | string subject | string terms | number wire | boolean
Metrics
Field | Type
- | - agents | array balance | number connected | number clouds | number customer | boolean dashboards | number devices | number developer | number emails | object interest | array notifications | number plans | number products | number software | number support | number users | number
Make
Endpoint
POST /account/make
Authorized User Role
support
Request Body
A object.
Response
Field | Type
- | - activity | date billing | object closed | boolean created | date email | string id | string metrics | object name | string suspended | boolean
Billing
Field | Type
- | - address | string agreement | boolean cardId | string canWire | boolean company | string country | string credit | number error | string invoiceEmail | string memo | string order | string renew | date renewing | boolean stripeId | string subject | string terms | number wire | boolean
Metrics
Field | Type
- | - agents | array balance | number connected | number clouds | number customer | boolean dashboards | number devices | number developer | number emails | object interest | array notifications | number plans | number products | number software | number support | number users | number
Remove
Endpoint
POST /account/remove
Authorized User Role
support
Request Body
Field | Type
- | - id | string email | string
Suspend
Endpoint
POST /account/suspend
Authorized User Role
support
Request Body
Field | Type
- | - id | string suspended | boolean
Response
Field | Type
- | - activity | date billing | object closed | boolean created | date email | string id | string metrics | object name | string suspended | boolean
Billing
Field | Type
- | - address | string agreement | boolean cardId | string canWire | boolean company | string country | string credit | number error | string invoiceEmail | string memo | string order | string renew | date renewing | boolean stripeId | string subject | string terms | number wire | boolean
Metrics
Field | Type
- | - agents | array balance | number connected | number clouds | number customer | boolean dashboards | number devices | number developer | number emails | object interest | array notifications | number plans | number products | number software | number support | number users | number
UpdateBilling
Update account billing details
Endpoint
POST /account/updateBilling
Authorized User Role
admin
Request Body
Field | Type | Required
- | - | - id | string | yes address | string | company | string | country | string | invoiceEmail | string | order | string | subject | string |
Response
An account object.
Field | Type
- | - activity | date billing | object closed | boolean created | date email | string id | string metrics | object name | string suspended | boolean
Billing
Field | Type
- | - address | string agreement | boolean cardId | string canWire | boolean company | string country | string credit | number error | string invoiceEmail | string memo | string order | string renew | date renewing | boolean stripeId | string subject | string terms | number wire | boolean
Metrics
Field | Type
- | - agents | array balance | number connected | number clouds | number customer | boolean dashboards | number devices | number developer | number emails | object interest | array notifications | number plans | number products | number software | number support | number users | number
UpdateIdentity
Update account name and email
Endpoint
POST /account/updateIdentity
Authorized User Role
admin
Request Body
Field | Type | Required
- | - | - id | string | yes email | string | name | string |
Response
An account object.
Field | Type
- | - activity | date billing | object closed | boolean created | date email | string id | string metrics | object name | string suspended | boolean
Billing
Field | Type
- | - address | string agreement | boolean cardId | string canWire | boolean company | string country | string credit | number error | string invoiceEmail | string memo | string order | string renew | date renewing | boolean stripeId | string subject | string terms | number wire | boolean
Metrics
Field | Type
- | - agents | array balance | number connected | number clouds | number customer | boolean dashboards | number devices | number developer | number emails | object interest | array notifications | number plans | number products | number software | number support | number users | number
UpdateMetrics
Update account metrics
Endpoint
POST /account/updateMetrics
Authorized User Role
support
Request Body
Field | Type | Required
- | - | - id | string | yes metrics | object | yes
Response
An account object.
Field | Type
- | - activity | date billing | object closed | boolean created | date email | string id | string metrics | object name | string suspended | boolean
Billing
Field | Type
- | - address | string agreement | boolean cardId | string canWire | boolean company | string country | string credit | number error | string invoiceEmail | string memo | string order | string renew | date renewing | boolean stripeId | string subject | string terms | number wire | boolean
Metrics
Field | Type
- | - agents | array balance | number connected | number clouds | number customer | boolean dashboards | number devices | number developer | number emails | object interest | array notifications | number plans | number products | number software | number support | number users | number
UpdatePayment
Update account payment information
Endpoint
POST /account/updatePayment
Authorized User Role
support
Request Body
Field | Type | Required
- | - | - id | string | yes agreement | boolean | canWire | boolean | credit | number | renew | date | renewing | boolean | terms | number | wire | boolean |
Response
An account object.
Field | Type
- | - activity | date billing | object closed | boolean created | date email | string id | string metrics | object name | string suspended | boolean
Billing
Field | Type
- | - address | string agreement | boolean cardId | string canWire | boolean company | string country | string credit | number error | string invoiceEmail | string memo | string order | string renew | date renewing | boolean stripeId | string subject | string terms | number wire | boolean
Metrics
Field | Type
- | - agents | array balance | number connected | number clouds | number customer | boolean dashboards | number devices | number developer | number emails | object interest | array notifications | number plans | number products | number software | number support | number users | number