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
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
trial_end_date
string format: date-time
nullable
shopify_app_store_referral?
boolean
trialing?
boolean
paying
boolean
has_ever_created_remote_channel
boolean
owner

The company owner user record.

object
id
integer
login
string
email
string
timezone
string
role_id
integer
default_warehouse_id
integer
nullable
default_channel_id
integer
nullable
two_factor_authentication_enabled
boolean
created_at
string format: date-time
updated_at
string format: date-time
employees

All company users.

Array<object>
object
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
g
dimensions_unit
string
cm
timezone
string
pull_fba_inbound_stock
boolean
stock_change_reason_required
boolean
auto_allocation_enabled
boolean
automated_packing_flow
boolean
phone_payments
boolean
date_format
string
Example
{
  "id": 21456,
  "name": "ACME",
  "created_at": "2020-05-01T09:00:00Z",
  "updated_at": "2026-01-10T12:00:00Z",
  "referring_website": null,
  "has_right_to_use_veeqo": true,
  "billing_period_started": "2026-01-01T00:00:00Z",
  "chargify_product_handle": "veeqo-shipping-gb",
  "chargify_current_plan": {
    "product_handle": "veeqo-shipping-gb"
  },
  "active_features": [
    "multiple_carrier_accounts"
  ],
  "veeqo_product_name": "veeqo-shipping",
  "plan_features": {
    "purchase_orders": {
      "any_actions": true
    },
    "api": {
      "any_actions": true
    }
  },
  "paid_plan_features": {},
  "trial_end_date": null,
  "trialing?": false,
  "paying": true,
  "has_ever_created_remote_channel": true
}