Get account

The Get account method returns account details for the current reseller or any of its downstream resellers.

An API token of a manager is required for authorization. To get an API token via the Operator Control Panel, see Viewing and updating manager's information.

The manager's API token specified in an API request determines:

The role and access level of the manager, which determine the availability of a method.
The current reseller and downstream resellers accessible within a method.

GET {base_url}/api/v3/resellers/{reseller_id}/accounts/{account_id}

Arguments

Name	Parameter type	Data type	Required/Optional	Description
X-Api-Token	header	string	Required	API token of a manager that performs the operation (see Viewing and updating manager's information)
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 Viewing and updating reseller general information)
account_id	path	integer	Required	ID of the account

Response model

Name					Data type	Description
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 Viewing and updating account's details 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 (см. Viewing the list of account types)
		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 Viewing and updating account's details)
		bill_user_id			integer	ID of the account's гser selected as Billing contact (see Viewing and updating account's details)
		custom_attributes			object	Account attributes (see Managing attributes)
			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 Managers' roles)
			custom_attributes		array	The list of the manager's additional attributes (see Viewing the list of attribute categories)
				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 Managing account's users)
			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 Managing responsible managers)
			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 Viewing the list of account types)
			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 Configuring payment methods)
			ancestry		string	ID of the parent account type
		account_class			string	Information about the account class (see Viewing the list of account classes)
			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 Creating an account class)
			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 Viewing the list of accounts) 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 Creating an account class)
			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

Request example

GET /api/v3/resellers/1/accounts/505
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json

Response example

{
    "data": {
        "id": "505",
        "type": "accounts",
        "attributes": {
            "created_at": "2019-10-15T13:08:36.440+03:00",
            "updated_at": "2020-07-07T11:06:27.264+03:00",
            "reseller_id": 1,
            "name": "Marcelo  Ivanou",
            "account_class_id": 1,
            "primary_name": "Test api doc",
            "first_name": "Marcelo",
            "middle_name": "",
            "last_name": "Ivanou",
            "country": "BY",
            "region": "minsk",
            "city": "minsk",
            "street": "Lenina",
            "building": "1",
            "office": "",
            "zip": "220007",
            "phone": "+375295555555",
            "email": "test@example.com",
            "status": "active",
            "balance": "380.39",
            "usable_balance": "380.39",
            "current_debt": 0.0,
            "subscription_credit_limit": 11000.0,
            "financial_blocking_threshold": 0.0,
            "account_type_id": 1,
            "manager_id": 50,
            "owner_id": 874,
            "tech_user_id": 874,
            "bill_user_id": 874,
            "custom_attributes": {
                "birth_date": "10.08.2016",
                "dns": "",
                "invoice": "",
                "passport_date_of_issue": "01.07.2016",
                "passport_issued_by": "Goverment",
                "passport_number": "1124111111122",
                "personal_number": "A4411111BB1199"
            },
            "manager": {
                "created_at": "2016-11-30T13:16:27.169+03:00",
                "updated_at": "2019-11-22T14:13:28.970+03:00",
                "reseller_id": 1,
                "id": 50,
                "name": "Sales manager",
                "status": "active",
                "email": "test@gmail.com",
                "role": "sales",
                "custom_attributes": {
                        "ManagerString": "Test"
                    }
            },
            "owner": {
                "created_at": "2016-10-26T17:38:37.551+03:00",
                "updated_at": "2016-12-23T15:04:48.172+03:00",
                "email": "owner@example.by",
                "account_status": "active",
                "global_status": "active",
                "first_name": "Alex",
                "middle_name": "",
                "last_name": "Owner"
            },
			"account_product_managers": [
                {
                    "id": 431,
                    "account_id": 710,
                    "product_id": 400,
                    "responsible_product_manager_id": 3,
                    "manager_product_role_id": 2,
                    "created_at": "2020-12-09T06:15:52.348+03:00",
                    "updated_at": "2020-12-16T15:38:56.541+03:00"
                },
                {
                    "id": 9,
                    "account_id": 710,
                    "product_id": 400,
                    "responsible_product_manager_id": 1,
                    "manager_product_role_id": 1,
                    "created_at": "2020-12-09T06:13:40.744+03:00",
                    "updated_at": "2020-12-16T15:38:56.533+03:00"
                }
            ],
            "self_registration": false,
			"default_payment_model": "postpay",
            "account_type": {
                "id": 1,
                "name": "Personal BLR",
                "created_at": "2016-08-25T09:26:12.658+03:00",
                "updated_at": "2021-03-04T06:12:01.425+03:00",
                "reseller_id": 1,
                "name_pattern": "%first_name %middle_name %last_name",
                "primary_name": "",
                "key": "personalblr",
                "default_payment_method_id": 2,
                "ancestry": null,
                "use_by_default": true
            },
            "account_class": {
                "id": 1,
                "reseller_id": 1,
                "name": "Default",
                "created_at": "2016-08-25T09:26:12.820+03:00",
                "updated_at": "2020-09-05T10:29:21.844+03:00",
                "financial_blocking_threshold": "0.0",
                "due_order_period": 90,
                "subzero_period": 0,
                "stop_subscription_type": "automatically",
                "key": "default",
                "color": "grey",
                "guaranteed_payment_limit": 1000,
                "guaranteed_payment_period": 7,
                "delete_subscription_type": "automatically",
                "denominated": false,
                "buy_with_negative_balance": false,
                "receipt_day": null,
                "payment_model": "postpay",
                "default": true,
                "due_payment_period": 3,
                "subscription_credit_limit": "222.0"
            }
        },
        "relationships": {
            "subscriptions": {
                "data": [
                    {
                        "id": "3005863",
                        "type": "subscriptions"
                    },
                    {
                        "id": "3005862",
                        "type": "subscriptions"
                    },
                    {
                        "id": "3005749",
                        "type": "subscriptions"
                    },
                    {
                        "id": "3005691",
                        "type": "subscriptions"
                    },
                    {
                        "id": "3006017",
                        "type": "subscriptions"
                    },
                    {
                        "id": "3005871",
                        "type": "subscriptions"
                    },
                    {
                        "id": "3005868",
                        "type": "subscriptions"
                    },
                    {
                        "id": "3006016",
                        "type": "subscriptions"
                    },
                    {
                        "id": "3005870",
                        "type": "subscriptions"
                    },
                    {
                        "id": "3005869",
                        "type": "subscriptions"
                    },
                    {
                        "id": "3005867",
                        "type": "subscriptions"
                    },
                    {
                        "id": "3005865",
                        "type": "subscriptions"
                    },
                    {
                        "id": "3005875",
                        "type": "subscriptions"
                    },
                    {
                        "id": "3005866",
                        "type": "subscriptions"
                    },
                    {
                        "id": "3005864",
                        "type": "subscriptions"
                    },
                    {
                        "id": "3005861",
                        "type": "subscriptions"
                    },
                    {
                        "id": "3006034",
                        "type": "subscriptions"
                    }
                ]
            }
        }
    }
}