Skip to content
Veeqo, An Amazon company Developers
Login Signup

View Company Detail

GET
/current_company

Returns the current company, including its account capabilities: billing plan, active features and the plan capability trees.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

object
trial_end_date
string format: date-time
nullable
shopify_app_store_referral?
boolean
trialing?
boolean
paying
boolean
has_ever_created_remote_channel
boolean
id
integer
name
string
created_at
string format: date-time
updated_at
string format: date-time
referring_website
string
nullable
has_right_to_use_veeqo
boolean
billing_period_started
string format: date-time
nullable
chargify_product_handle

Current billing plan handle. trial for trialing accounts.

string
chargify_current_plan

Current billing plan details (product_handle plus pricing fields). Trialing accounts resolve to the unlimited plan.

object
active_features

Feature flag names currently active for this company.

Array<string>
veeqo_product_name

Product family, e.g. veeqo-shipping or veeqo-power.

string
plan_features

Nested capability tree — category to action to boolean — reflecting what the current plan (plus feature flag overrides) allows, e.g. {“purchase_orders”: {“any_actions”: true}}.

object
paid_plan_features

Paid subscription features with usage data. Null if the subscription service is unavailable.

object
owner

A user record.

object
id
integer
login

Display name.

string
email
string
account_owner_user_id
integer
nullable
activation_code
string
nullable
activated_at
string format: date-time
nullable
location
string
nullable
created_at
string format: date-time
created_by_id
integer
nullable
updated_at
string format: date-time
updated_by_id
integer
nullable
deleted_at
string format: date-time
nullable
deleted_by_id
integer
nullable
guide_progress
string
nullable
company_id
integer
guide_completed_message_viewed
boolean
nullable
orders_walkthrough_viewed
boolean
default_warehouse_id
integer
nullable
timezone
string
failed_login_attempts
integer
default_channel_id
integer
nullable
two_factor_authentication_enabled
boolean
role_id
integer
new_orders_opted_in
boolean
new_products_opted_in
boolean
default_order_view_id
integer
nullable
employees

All company users.

Array<object>

A user record.

object
id
integer
login

Display name.

string
email
string
account_owner_user_id
integer
nullable
activation_code
string
nullable
activated_at
string format: date-time
nullable
location
string
nullable
created_at
string format: date-time
created_by_id
integer
nullable
updated_at
string format: date-time
updated_by_id
integer
nullable
deleted_at
string format: date-time
nullable
deleted_by_id
integer
nullable
guide_progress
string
nullable
company_id
integer
guide_completed_message_viewed
boolean
nullable
orders_walkthrough_viewed
boolean
default_warehouse_id
integer
nullable
timezone
string
failed_login_attempts
integer
default_channel_id
integer
nullable
two_factor_authentication_enabled
boolean
role_id
integer
new_orders_opted_in
boolean
new_products_opted_in
boolean
default_order_view_id
integer
nullable
company_address
object
address_line_1
string
address_line_2
string
nullable
address_line_3
string
nullable
post_code
string
city
string
region
string
nullable
country
string
phone
string
nullable
settings

Company-wide settings.

object
id
integer
currency_code
string
charge_taxes_on_shipping_rates
boolean
point_of_sale_enabled
boolean
require_complete_packing
boolean
phone_number
string
nullable
weight_unit
string
oz
dimensions_unit
string
inches
timezone
string
pull_fba_inbound_stock
boolean
stock_change_reason_required
boolean
auto_allocation_enabled
boolean
link_similar_amazon_listings_within_marketplace
boolean
link_similar_amazon_listings_within_region
boolean
link_similar_amazon_listings_across_fba_and_fbm
boolean
automated_packing_flow
boolean
phone_payments
boolean
date_format
string
Example
{
  "trial_end_date": "2038-01-18T23:59:59.000Z",
  "shopify_app_store_referral?": false,
  "trialing?": false,
  "paying": false,
  "has_ever_created_remote_channel": true,
  "id": 10001,
  "name": "Acme Corp",
  "created_at": "2025-01-01T09:00:00.000Z",
  "updated_at": "2026-01-10T12:00:00.000Z",
  "referring_website": null,
  "has_right_to_use_veeqo": true,
  "billing_period_started": null,
  "chargify_product_handle": "trial",
  "chargify_current_plan": null,
  "active_features": [
    "profit_analyzer",
    "multiple_carrier_accounts",
    "v1_api_access"
  ],
  "veeqo_product_name": "veeqo-power-us",
  "plan_features": {
    "purchase_orders": {
      "any_actions": true
    },
    "api": {
      "any_actions": true
    }
  },
  "paid_plan_features": {
    "CHANNEL": [
      {
        "name": "PRODUCT_LISTING",
        "condition": {
          "limit": 10,
          "usage": 0,
          "listing_ids": []
        }
      }
    ]
  },
  "owner": {
    "id": 5001,
    "login": "Jane Doe",
    "email": "jane.doe@example.com",
    "account_owner_user_id": null,
    "activation_code": null,
    "activated_at": null,
    "location": null,
    "created_at": "2025-01-01T09:00:00.000Z",
    "created_by_id": null,
    "updated_at": "2026-01-10T12:00:00.000Z",
    "updated_by_id": null,
    "deleted_at": null,
    "deleted_by_id": null,
    "guide_progress": null,
    "company_id": 10001,
    "guide_completed_message_viewed": null,
    "orders_walkthrough_viewed": false,
    "default_warehouse_id": null,
    "timezone": "Etc/UTC",
    "failed_login_attempts": 0,
    "default_channel_id": null,
    "two_factor_authentication_enabled": true,
    "role_id": 501,
    "new_orders_opted_in": true,
    "new_products_opted_in": true,
    "default_order_view_id": null
  },
  "employees": [
    {
      "id": 5001,
      "login": "Jane Doe",
      "email": "jane.doe@example.com",
      "account_owner_user_id": null,
      "activation_code": null,
      "activated_at": null,
      "location": null,
      "created_at": "2025-01-01T09:00:00.000Z",
      "created_by_id": null,
      "updated_at": "2026-01-10T12:00:00.000Z",
      "updated_by_id": null,
      "deleted_at": null,
      "deleted_by_id": null,
      "guide_progress": null,
      "company_id": 10001,
      "guide_completed_message_viewed": null,
      "orders_walkthrough_viewed": false,
      "default_warehouse_id": null,
      "timezone": "Etc/UTC",
      "failed_login_attempts": 0,
      "default_channel_id": null,
      "two_factor_authentication_enabled": true,
      "role_id": 501,
      "new_orders_opted_in": true,
      "new_products_opted_in": true,
      "default_order_view_id": null
    }
  ],
  "company_address": {
    "address_line_1": "123 Example St",
    "address_line_2": "",
    "address_line_3": "",
    "post_code": "90001",
    "city": "Anytown",
    "region": "CA",
    "country": "US",
    "phone": "+1 555-0100"
  },
  "settings": {
    "id": 1001,
    "currency_code": "USD",
    "charge_taxes_on_shipping_rates": true,
    "point_of_sale_enabled": false,
    "require_complete_packing": false,
    "phone_number": "+1 555-0100",
    "weight_unit": "oz",
    "dimensions_unit": "inches",
    "timezone": "Etc/UTC",
    "pull_fba_inbound_stock": false,
    "stock_change_reason_required": false,
    "auto_allocation_enabled": true,
    "link_similar_amazon_listings_within_marketplace": false,
    "link_similar_amazon_listings_within_region": false,
    "link_similar_amazon_listings_across_fba_and_fbm": false,
    "automated_packing_flow": false,
    "phone_payments": false,
    "date_format": "mm/dd/yyyy"
  }
}