Skip to content

Accounts

List All Accounts

This is not account scoped and will return ALL accounts this user has access to.

GET /api/accounts

Returned Params
  • accounts: Array
    • id: String
    • name: String
    • term: String
    • reseller: Boolean
    • is_trial: Boolean
    • trial_start: DateTime
    • trial_end: DateTime
    • parent_account: Object
      • id: String
      • name: String
    • reseller_billing_plan: Object
      • id: String
      • name: String
    • created_at
    • updated_at

View Account

GET /api/account/:id

Returned Params
  • account: Object
    • id: String
    • name: String
    • term: String
    • reseller: Boolean
    • is_trial: Boolean
    • trial_start: DateTime
    • trial_end: DateTime
    • parent_account: Object
      • id: String
      • name: String
    • reseller_billing_plan: Object
      • id: String
      • name: String
    • created_at
    • updated_at

Create Account

Account Scope Required, please include X-Auth-Account header with your Account ID.

POST /api/accounts

Params
  • account: Object
    • name: String
    • term: String | monthly or annual
    • reseller_billing_plan_id: Integer

Update Account

PATCH /api/accounts/:id

Params
  • account: Object
    • name: String
    • reseller_billing_plan_id: Integer