Get account

X-Api-Token

header

string

Required

API token of a manager that performs the operation (see

)

Content-Type

header

string

Required

Media type of the request. Specify the following: application/vnd.api+json

Accept

header

string

Required

Supported media types of the answer. Specify the following: application/vnd.api+json

base_url

path

string

Required

ActivePlatform URL

reseller_id

path

integer

Required

ID of the current reseller or any of its downstream resellers (see 

)

account_id

path

integer

Required

ID of the account

data

object

Response data

id

integer

Account ID

type

string

Data type

attributes

object

Account information

created_at

date

Date and time of account creation

updated_at

date

Data and time of account last update

reseller_id

integer

ID of the account's reseller

name

string

Account name

account_class_id

integer

Account class ID

primary_name

string

Primary name of the account. For example, a company name

first_name

string

The first name of the contract person

middle_name

string

The middle name of the contract person

last_name

string

The last name of the contract person

country

string

Contact information: a two-letter ISO code ISO 3166-1 alpha-2 of the country

region

string

Contact information: Region

city

string

Contact information: City

street

string

Contact information: Street

building

string

Contact information: Building

office

string

Contact information: Office

zip

string

Contact information: Zip-code

phone

string

Contact information: Phone number:

• + < country code > < city code or network code > < phone number >.

• 00 < country code > < city code or network code > < phone number >.

email

string

Email of the contract person

status

string

Account status (see  for the list of statuses)

balance

string

Total account balance as a sum of available funds (see usable_balance) and blocked сharges

usable_balance

string

Available funds on the account balance

current_debt

float

Current debt of the account for all postpaid subscriptions

subscription_credit_limit

float

The value of the subscription credit limit for the account that is set in the account class or redefined on the account level

financial_blocking_threshold

float

The value of the financial blocking threshold for the account that is set in the account class or redefined on the account level

account_type_id

integer

Account type ID (см.

)

manager_id

integer

Account's manager ID

owner_id

integer

Account's Owner ID

tech_user_id

integer

ID of the account's гser selected as Tech contact (see )

bill_user_id

integer

ID of the account's гser selected as Billing contact (see 

)

custom_attributes

object

Account attributes (see )

attributes.custom-attributes['custom-attribute-key']

string

Account attribute value

manager

array

Information about the account's manager

created_at

date

Date and time of the manager creation

updated_at

date

Data and time of the manager last update

reseller_id

integer

ID of the manager's reseller

id

integer

ID of the manager

name

string

Name of the manager

status

string

Status of the manager:

• active — access to the Operator Control Panel is allowed.

• inactive — access to the Operator Control Panel is blocked.

email

string

Manager's email which is used as a login to the Operator Control Panel

role

string

Manager's role (for the list of roles, see

)

custom_attributes

array

The list of the manager's additional attributes (see 

)

manager.custom-attributes['custom-attribute-key']

string

The value of the attribute

owner

object

information about the Owner of the account

created_at

string

Date and time of account's Owner creation

updated_at

string

Date and time of account's Owner last update

email

string

Email of the account's Owner

account_status

string

Account's Owner status for the account (for information about statues, see

)

global_status

string

Account's Owner status in ActivePlatform

first_name

string

The first name of the account's Owner

middle_name

string

The middle name of the account's Owner

ast_name

string

The last name of the account's Owner

account_product_managers

array of objects

Responsible managers of the account (see

)

id

integer

ID of information about the responsible manager

account_id

integer

Account ID

product_id

integer

Product ID

responsible_product_manager_id

integer

Responsible manager ID within the product

manager_product_role_id

integer

Manager role ID within the product

created_at

date

Date and time when information about the responsible manager was created

updated_at

date

Date and time when information about the responsible manager was updated

self_registration

bool

Indicates whether the account was created by completing the self-registration process in the Customer Control Panel:

• true — the account was created by completing the self-registration process in the Customer Control Panel.

• false — the account was created by a manager via the Operator Control Panel or API.

default_payment_model

string

Default payment model:

• prepay

• postpay

account_type

object

Information about the account type (see

)

id

integer

ID of the account type

name

string

Name of the account type

created_at

date

Date and time of the account type creation

updated_at

date

Date and time when the account type was updated

reseller_id

integer

ID of the reseller linked to the account type

name_pattern

string

Template of the account type name which is displayed in the platform

primary_name

string

Name of the field with the primary name of the account. For example, for the Business account type, the filed may be named as Company name

key

string

Key that is used to refer to the account type by API or a placeholder

default_payment_method_id

integer

ID of the default payment method (see 

)

ancestry

string

ID of the parent account type

account_class

string

Information about the account class (see 

)

id

integer

ID of the account class

reseller_id

integer

ID of the linked reseller

name

string

Name of the account class

created_at

date

Date and time of the account type creation

updated_at

date

Date and time when the account type was updated

financial_blocking_threshold

float

The value of the financial blocking threshold that is set in the account class

due_order_period

integer

Number of days to pay for an order before the order becomes canceled (for the Prepay payment model)

subzero_period

integer

Number of days during which the account balance can be negative without moving the account to the Credit hold status. The -1 value refers to the unlimited period

stop_subscription_type

string

Type of the subscription stopping if the account is moved to the Credit hold status (for the list of the available types of the subscription stopping, see

)

key

string

 Key that is used to refer to the account class by API or placeholders

color

string

Color that is used in the List of accounts (see 

) for this account type

guaranteed_payment_limit

integer

Maximum amount of the guaranteed payment that all accounts, which are added to the account class, can use

guaranteed_payment_period

integer

Number of days, during which all accounts, which are added to the account class, can use the Guaranteed payments

delete_subscription_type

string

Type of the subscription deleting (for the list of the available types of the subscription deleting, see

)

denominated

bool

Attribute of the account type denomination:

• true — the account type is denominated.

• false — the account type is not denominated.

buy_with_negative_balance

bool

Availability of paying for orders with the negative account balance (for the Prepay payment model):

• true — paying for orders with the negative account balance is available.

• false — paying for orders with the negative account balance is not available.

receipt_day

integer

Deprecated

payment_model

string

Payment model:

• prepay

• postpay

default

bool

Default account type for new accounts:

• true — the account type is applied to new accounts.

• false — the account type is not applied to new accounts.

due_payment_period

integer

Number of days to pay for a payment before the payment becomes expired (for the Postpay payment model)

subscription_credit_limit

float

The value of the subscription credit limit that is set in the account class

relationships

object

Information about the related objects

subscriptions

object

Information about the related subscriptions

data

array

Information about the subscription

id

integer

ID of the subscription

type

string

Data type