Account information
Returns information about your Bytio Account such as what Plan you are on, billing and spend information.
curl --request GET \
--url https://api.bytio.com/v1/account/info \
--header 'X-API-KEY: <api-key>'{
"status": "ok",
"user": {
"user_id": "<string>",
"api_key": "<string>",
"team_id": "<string>",
"name": "Adam Smith",
"email": "adam.smith@email.com",
"role": "admin",
"picture": "<string>"
},
"kyc": {
"completed_on": "2023-11-07T05:31:56Z"
},
"billing": {
"status": "active",
"pending_account_closure_date": "2023-11-07T05:31:56Z",
"pending_downgrade_plan_date": "2023-11-07T05:31:56Z",
"pending_downgrade_plan_id": "<string>",
"address": {
"company_name": "My Company",
"address_1": "Unit 1",
"address_2": "My Street",
"city": "My City",
"state": "My State",
"zipcode": 12345,
"country_code": "us"
},
"balance": {
"amount_cents": 5895.3554498,
"trial_amount_cents": 1006.3245875,
"trial_expires_on": "2023-11-07T05:31:56Z",
"amount_total_cents": 6901.6800373
},
"spend": {
"amount_cents": 6584.32589,
"minimum_monthly_spend_met": true,
"prorata_amount_cents": 254.297465
}
},
"plan": {
"plan_id": "<string>",
"is_pay_as_you_go": true,
"name": "Starter",
"minimum_monthly_spend_cents": 123,
"prorata_minimum_monthly_spend_cents": 123,
"next_payment_date": "2023-11-07T05:31:56Z"
}
}Authorizations
Response
ok The ID of the user making the request.
The API key (also used as the proxy zone password) of the user making the request.
The ID of the team that the user making the request belongs to.
The name of the user making the request, as set on the Profile page of the dashboard.
25The email address of the user making the request, as set on the Profile page of the dashboard.
250The role the user making the request is in. The role a user is set to defines their permissions. See the Docs for more information https://docs.bytio.com/account/roles
admin, collaborator, billing_admin A URL to the avatar image for the user making the request. If no avatar is set for the user then picture is set to null.
An object returning the status of the Know Your Customer (KYC) identity verification process. You can learn more about the Bytio KYC process here - https://docs.bytio.com/account/kyc
The UTC date and time that your account completed the Know Your Customer (KYC) identity verification process.
The status of the Bytio account.
active means there are no issues with the account and it`s currently active.
unverified if you have signed up but not verified your email, and therefore can`t make proxy requests through zones (to remedy this you should verify your email on the Profile page of the Dashboard).
insufficient_balance when your account balance is too too low to cover the usage and/or standing (time-based) charges for your provisioned zones (to remedy this you should add funds to your account balance either via the API or on the Billing page of the Dashboard).
insufficient_plan_minimum_spend if your payment method failed when Bytio attempted to collect your minimum monthly spend amount (if you`re on a pay-monthly plan).
pending_account_closure when your account has been set to close at the end of the current billing cycle. See pending_account_closure_date for the date the account closure will occur.
pending_downgrade_plan when your account has been set to downgrade to a lower plan at the end of the current billing cycle. See pending_downgrade_plan_date for the date the downgrade will occur and pending_downgrade_plan_id for the ID of the plan the account will be downgraded to.
suspendeed means the account is currently suspended and in-review by the Bytio team. An account will enter this status where potential abuse (such as attempting to open multiple Free Trials) is detected. Contact the Bytio team for more information about restoring an account in the suspended state.
active, unverified, insufficient_balance, insufficient_plan_minimum_spend, pending_account_closure, pending_downgrade_plan The UTC date and time the of the pending account closure when status=pending_account_closure, in ISO 8601 format. If the account is not pending closure the pending_account_closure_date key is not present.
The UTC date and time the of the pending plan downgrade when status=pending_downgrade_plan, in ISO 8601 format. If the account is not pending a plan downgrade the pending_downgrade_plan_date key is not present.
The ID of the plan the account is pending downgrade to when status=pending_downgrade_plan.
An object returning the address information set on the account, as-entered in the Billing page of the Dashboard. This information is displayed on all monthly invoices generated by Bytio.
The company name.
The first line of the address.
The second line of the address.
The city the address.
The state the address.
The zipcode or postal code the address.
An ISO 3166 two-letter country code.
An object returning the status of your account balance.
The amount, in cents, of your current account balance not including trial_amount_cents (i.e. excluding any free trial balance). Note that fractional cents are returned here but the platform rounds up to 2 decimal places for billing purposes.
The amount, in cents, of your remaining free trial credit. If you have fully used your free trial credit, or it has expired, then trial_amount_cents will be set to null. Note that fractional cents are returned here but the platform rounds up to 2 decimal places for billing purposes.
The UTC date and time that your free trial credit expires, in ISO 8601 format. If you have fully used your free trial credit, or it has expired, then trial_expires_on will be set to null.
The amount, in cents, of your current account balance including any remaining free trial balance. Note that fractional cents are returned here but the platform rounds up to 2 decimal places for billing purposes.
An object returning your spend within the current month and whether the minimum monthly spend criteria of your plan (if your account is not on the Pay As You Go plan) has been met.
The amount, in cents, that your account has spend in the current billing period (i.e. the current month). Note that fractional cents are returned here but the platform rounds up to 2 decimal places for billing purposes.
If your account is on a monthly plan minimum_monthly_spend_met will be set to true if you have met the minimum monthly spend for your plan in the current month. Set to false otherwise. If your account is on the Pay As You Go plan then minimum_monthly_spend_met will be null. You can check plan.minimum_monthly_spend_cents to view the minimum monthly spend for your current plan.
If your account has been upgraded in the current month, then prorata_amount_cents represents the spend that has occurred on the current plan and excludes the spend that may have occurred on your previous plan. If your account has not been upgraded within the current month then prorata_amount_cents will be null. Note that fractional cents are returned here but the platform rounds up to 2 decimal places for billing purposes.
The ID of the plan the account is currently on.
Set to true when the account is on the Pay As You Go plan (the default for new accounts) or false otherwise.
The human-readable name of the plan the account is currently on.
The minimum monthly spend required by the plan the account is currently on. If the account is on the Pay As You Go plan then minimum_monthly_spend_cents will be set to 0.
Populated when the account has changed plan (upgraded) within the current billing cycle, set to null otherwise. prorata_minimum_monthly_spend_cents shows the pro-rated, lower, minimum monthly spend required for the current month. For example, if an account is upgraded to a plan with a minimum monthly spend of $10 halfway through the month, on the 15th, then prorata_minimum_monthly_spend_cents would be 500 ($5).
The UTC date and time the of the next plan payment date, in ISO 8601 format. If the account is on the Pay As You Go plan then next_payment_date will be set to null. The Bytio billing cycle follows the calendar month so next_payment_date is typically midnight on the first day of the next month.
curl --request GET \
--url https://api.bytio.com/v1/account/info \
--header 'X-API-KEY: <api-key>'{
"status": "ok",
"user": {
"user_id": "<string>",
"api_key": "<string>",
"team_id": "<string>",
"name": "Adam Smith",
"email": "adam.smith@email.com",
"role": "admin",
"picture": "<string>"
},
"kyc": {
"completed_on": "2023-11-07T05:31:56Z"
},
"billing": {
"status": "active",
"pending_account_closure_date": "2023-11-07T05:31:56Z",
"pending_downgrade_plan_date": "2023-11-07T05:31:56Z",
"pending_downgrade_plan_id": "<string>",
"address": {
"company_name": "My Company",
"address_1": "Unit 1",
"address_2": "My Street",
"city": "My City",
"state": "My State",
"zipcode": 12345,
"country_code": "us"
},
"balance": {
"amount_cents": 5895.3554498,
"trial_amount_cents": 1006.3245875,
"trial_expires_on": "2023-11-07T05:31:56Z",
"amount_total_cents": 6901.6800373
},
"spend": {
"amount_cents": 6584.32589,
"minimum_monthly_spend_met": true,
"prorata_amount_cents": 254.297465
}
},
"plan": {
"plan_id": "<string>",
"is_pay_as_you_go": true,
"name": "Starter",
"minimum_monthly_spend_cents": 123,
"prorata_minimum_monthly_spend_cents": 123,
"next_payment_date": "2023-11-07T05:31:56Z"
}
}