Account
v4.176.0 Get your account GET
https://api.linode.com/v4/account
Returns the contact and billing information related to your Account.
Authorizations personalAccessToken oauth account:read_only
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
Response Samples
200
default
{
"active_promotions" : [
{
"credit_monthly_cap" : "10.00" ,
"credit_remaining" : "50.00" ,
"description" : "Receive up to $10 off your services every month for 6 months! Unused credits will expire once this promotion period ends." ,
"expire_dt" : "2018-01-31T23:59:59" ,
"image_url" : "https://linode.com/10_a_month_promotion.svg" ,
"service_type" : "all" ,
"summary" : "$10 off your Linode a month!" ,
"this_month_credit_remaining" : "10.00"
}
],
"active_since" : "2018-01-01T00:01:01" ,
"address_1" : "123 Main Street" ,
"address_2" : "Suite A" ,
"balance" : 200 ,
"balance_uninvoiced" : 145 ,
"billing_source" : "akamai" ,
"capabilities" : [
"Linodes" ,
"NodeBalancers" ,
"Block Storage" ,
"Object Storage" ,
"Placement Groups"
],
"city" : "Philadelphia" ,
"company" : "Linode LLC" ,
"country" : "US" ,
"credit_card" : {
"expiry" : "11/2022" ,
"last_four" : 1111
},
"email" : "john.smith@linode.com" ,
"euuid" : "E1AF5EEC-526F-487D-B317EBEB34C87D71" ,
"first_name" : "John" ,
"last_name" : "Smith" ,
"phone" : "215-555-1212" ,
"state" : "PA" ,
"tax_id" : "ATU99999999" ,
"zip" : "19102-1234"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Returns a single Account object.
array
of objects
string
The amount available to spend per month.
string
The total amount of credit left for this promotion.
string
A detailed description of this promotion.
string
When this promotion’s credits expire.
string
The location of an image for this promotion.
stringEnum:
all
backup
blockstorage
db_mysql
ip_v4
linode
linode_disk
linode_memory
loadbalancer
longview
managed
nodebalancer
placement_group
objectstorage
transfer_tx
The service to which this promotion applies.
string
Short details of this promotion.
this_month_credit_remaining
string
The amount of credit left for this month for this promotion.
string<date-time>
Read-only The date and time the account was activated.
string
<=
64
characters
First line of this Account’s billing address.
string
<=
64
characters
Second line of this Account’s billing address.
number
Read-only This Account’s balance, in US dollars.
number
Read-only This Account’s current estimated invoice in US dollars. This is not
your final invoice balance. Transfer charges are not included
in the estimate.
stringEnum:
akamai
linode
Read-only The source of service charges for this Account, as determined by its relationship
with Akamai. Accounts that are associated with Akamai-specific
customers return a value of akamai. All other Accounts return
a value of linode.
array
of strings
Read-only A list of capabilities your account supports.
string
<=
24
characters
The city for this Account’s billing address.
string
<=
128
characters
The company name associated with this Account.
Must not include any of the following characters: < > ( ) " =
string
The two-letter ISO 3166 country code of this Account’s billing address.
object
Read-only Credit Card information associated with this Account.
string
The expiration month and year of the credit card.
string
The last four digits of the credit card associated with this Account.
string
<=
128
characters
The email address of the person associated with this Account.
string<uuid>
Read-only An external unique identifier for this account.
string
<=
50
characters
The first name of the person associated with this Account.
Must not include any of the following characters: < > ( ) " =
string
<=
50
characters
The last name of the person associated with this Account.
Must not include any of the following characters: < > ( ) " =
string
<=
32
characters
The phone number associated with this Account.
string
<=
24
characters
If billing address is in the United States (US) or Canada (CA), only the two-letter
ISO 3166 State or Province code are accepted. If entering a
US military address, state abbreviations (AA, AE, AP) should
be entered. If the address is outside the US or CA, this is
the Province associated with the Account’s billing address.
string
<=
25
characters
The tax identification number associated with this Account, for tax calculations in
some countries. If you do not live in a country that collects
tax, this should be an empty string ("").
string
The zip code of this Account’s billing address. The following restrictions apply:
Can only contain ASCII letters, numbers, and hyphens (-). Must not contain more than 9 letter or number characters.
Error
array
of objects
string
The field in the request that caused this error. This may be a path,
separated by periods in the case of nested fields. In
some cases this may come back as “null” if the error is
not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed
immediately by changing the data you sent in the request,
but in some cases you will be instructed to Open a support
ticket
or perform some other action before you can complete the
request successfully.
Update your account PUT
https://api.linode.com/v4/account
Updates contact and billing information related to your account. If you exclude any properties from the request, the operation leaves them unchanged.
Note . When updating an account’s country to “US”, you’ll get an error if the account’s zip is not a valid US zip code.
Parent and child accounts
In a parent and child account environment, the following apply:
You can’t change the company for a parent account. Akamai uses this value to set the name for a child account parent user (proxy user) on any child account.
Child account users can’t run this operation. These users don’t have access to billing-related operations.
Authorizations personalAccessToken oauth account:read_write
Request Samples
Shell
CLI
curl -H "Content-Type: application/json" \
"Authorization: Bearer $TOKEN " \
'{
"address_1": "123 Main St.",
"address_2": "Suite 101",
"city": "Philadelphia",
"company": "My Company, LLC",
"country": "US",
"email": "jsmith@mycompany.com",
"first_name": "John",
"last_name": "Smith",
"phone": "555-555-1212",
"state": "PA",
"tax_id": "ATU99999999",
"zip": "19102"
}' \
linode-cli account update \
"123 Main St." \
"Suite 101" \
\
\ LLC \
\
\
\
\
\
\
\
19102
Request Body Schema string
<=
64
characters
First line of this Account’s billing address.
string
<=
64
characters
Second line of this Account’s billing address.
string
<=
24
characters
The city for this Account’s billing address.
string
<=
128
characters
The company name associated with this Account.
Must not include any of the following characters: < > ( ) " =
string
The two-letter ISO 3166 country code of this Account’s billing address.
string
<=
128
characters
The email address of the person associated with this Account.
string
<=
50
characters
The first name of the person associated with this Account.
Must not include any of the following characters: < > ( ) " =
string
<=
50
characters
The last name of the person associated with this Account.
Must not include any of the following characters: < > ( ) " =
string
<=
32
characters
The phone number associated with this Account.
string
<=
24
characters
If billing address is in the United States (US) or Canada (CA), only the two-letter
ISO 3166 State or Province code are accepted. If entering a US
military address, state abbreviations (AA, AE, AP) should be entered.
If the address is outside the US or CA, this is the Province associated
with the Account’s billing address.
string
<=
25
characters
The tax identification number associated with this Account, for tax calculations in some
countries. If you do not live in a country that collects tax,
this should be an empty string ("").
string
The zip code of this Account’s billing address. The following restrictions apply:
Can only contain ASCII letters, numbers, and hyphens (-). Must not contain more than 9 letter or number characters.
Response Samples
200
default
{
"active_promotions" : [
{
"credit_monthly_cap" : "10.00" ,
"credit_remaining" : "50.00" ,
"description" : "Receive up to $10 off your services every month for 6 months! Unused credits will expire once this promotion period ends." ,
"expire_dt" : "2018-01-31T23:59:59" ,
"image_url" : "https://linode.com/10_a_month_promotion.svg" ,
"service_type" : "all" ,
"summary" : "$10 off your Linode a month!" ,
"this_month_credit_remaining" : "10.00"
}
],
"active_since" : "2018-01-01T00:01:01" ,
"address_1" : "123 Main Street" ,
"address_2" : "Suite A" ,
"balance" : 200 ,
"balance_uninvoiced" : 145 ,
"billing_source" : "akamai" ,
"capabilities" : [
"Linodes" ,
"NodeBalancers" ,
"Block Storage" ,
"Object Storage" ,
"Placement Groups"
],
"city" : "Philadelphia" ,
"company" : "Linode LLC" ,
"country" : "US" ,
"credit_card" : {
"expiry" : "11/2022" ,
"last_four" : 1111
},
"email" : "john.smith@linode.com" ,
"euuid" : "E1AF5EEC-526F-487D-B317EBEB34C87D71" ,
"first_name" : "John" ,
"last_name" : "Smith" ,
"phone" : "215-555-1212" ,
"state" : "PA" ,
"tax_id" : "ATU99999999" ,
"zip" : "19102-1234"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
The updated Account.
array
of objects
string
The amount available to spend per month.
string
The total amount of credit left for this promotion.
string
A detailed description of this promotion.
string
When this promotion’s credits expire.
string
The location of an image for this promotion.
stringEnum:
all
backup
blockstorage
db_mysql
ip_v4
linode
linode_disk
linode_memory
loadbalancer
longview
managed
nodebalancer
placement_group
objectstorage
transfer_tx
The service to which this promotion applies.
string
Short details of this promotion.
this_month_credit_remaining
string
The amount of credit left for this month for this promotion.
string<date-time>
Read-only The date and time the account was activated.
string
<=
64
characters
First line of this Account’s billing address.
string
<=
64
characters
Second line of this Account’s billing address.
number
Read-only This Account’s balance, in US dollars.
number
Read-only This Account’s current estimated invoice in US dollars. This is not
your final invoice balance. Transfer charges are not included
in the estimate.
stringEnum:
akamai
linode
Read-only The source of service charges for this Account, as determined by its relationship
with Akamai. Accounts that are associated with Akamai-specific
customers return a value of akamai. All other Accounts return
a value of linode.
array
of strings
Read-only A list of capabilities your account supports.
string
<=
24
characters
The city for this Account’s billing address.
string
<=
128
characters
The company name associated with this Account.
Must not include any of the following characters: < > ( ) " =
string
The two-letter ISO 3166 country code of this Account’s billing address.
object
Read-only Credit Card information associated with this Account.
string
The expiration month and year of the credit card.
string
The last four digits of the credit card associated with this Account.
string
<=
128
characters
The email address of the person associated with this Account.
string<uuid>
Read-only An external unique identifier for this account.
string
<=
50
characters
The first name of the person associated with this Account.
Must not include any of the following characters: < > ( ) " =
string
<=
50
characters
The last name of the person associated with this Account.
Must not include any of the following characters: < > ( ) " =
string
<=
32
characters
The phone number associated with this Account.
string
<=
24
characters
If billing address is in the United States (US) or Canada (CA), only the two-letter
ISO 3166 State or Province code are accepted. If entering a
US military address, state abbreviations (AA, AE, AP) should
be entered. If the address is outside the US or CA, this is
the Province associated with the Account’s billing address.
string
<=
25
characters
The tax identification number associated with this Account, for tax calculations in
some countries. If you do not live in a country that collects
tax, this should be an empty string ("").
string
The zip code of this Account’s billing address. The following restrictions apply:
Can only contain ASCII letters, numbers, and hyphens (-). Must not contain more than 9 letter or number characters.
Error
array
of objects
string
The field in the request that caused this error. This may be a path,
separated by periods in the case of nested fields. In
some cases this may come back as “null” if the error is
not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed
immediately by changing the data you sent in the request,
but in some cases you will be instructed to Open a support
ticket
or perform some other action before you can complete the
request successfully.
Get a region's service availability GET
https://api.linode.com/v4/account/availability/{id}
View the available services for your account in a specific region.
Note . Only authorized users can access this.
Authorizations personalAccessToken oauth account:read_only
Path Parameters id string
Required The slug for the applicable data center. Run the List regions
operation to view the slug for each data center.
Request Samples
Shell
CLI
curl https://api.linode.com/v4/account/availability/us-east \
"Authorization: Bearer $TOKEN "
linode-cli account get-account-availability us-east
Response Samples
200
default
{
"available" : [
"Linodes" ,
"NodeBalancers"
],
"region" : "us-east" ,
"unavailable" : [
"Kubernetes" ,
"Block Storage"
]
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
The services available in the specified region.
array
of strings
Read-only A list of services available to your account in the region.
string
Read-only The Akamai cloud computing data center (region), represented by a slug
value. You can view a full list of regions and their associated
slugs with the List regions
operation.
array
of strings
Read-only A list of services unavailable to your account in the region.
Error
array
of objects
string
The field in the request that caused this error. This may be a path,
separated by periods in the case of nested fields. In
some cases this may come back as “null” if the error is
not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed
immediately by changing the data you sent in the request,
but in some cases you will be instructed to Open a support
ticket
or perform some other action before you can complete the
request successfully.
Cancel your account POST
https://api.linode.com/v4/account/cancel
Cancels an active Linode account. Akamai attempts to charge the credit card on file for any remaining balance. An error occurs if this charge fails.
Note . This operation can only be accessed by account users with unrestricted access.
Parent and child accounts In a parent and child account environment, the following apply:
A child account user can’t cancel a child account. You can’t cancel a parent account if it has an active child account. You need to work with your Akamai account team to dissolve any parent-child account relationships before you can fully cancel a child or parent account. Authorizations personalAccessToken oauth account:read_write
Request Samples
Shell
CLI
curl -H "Content-Type: application/json" \
"Authorization: Bearer $TOKEN " \
'{
"comments": "I am consolidating my accounts."
}' \
linode-cli account cancel \
"I'm consolidating my accounts"
Request Body Schema string
Any reason for cancelling the account, and any other comments you might have about your
Linode service.
Response Samples
200
409
default
{
"survey_link" : "https://alinktothesurvey.com"
}
{
"errors" : [
{
"reason" : "We were unable to charge your credit card for services rendered. We cannot cancel this account until the balance has been paid."
}
]
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
409
default
Account canceled
string
A link to Linode’s exit survey.
Could not charge the credit card on file
array
of objects
string
A string explaining that the account could not be canceled because there is
an outstanding balance on the account that must be paid
first.
Error
array
of objects
string
The field in the request that caused this error. This may be a path,
separated by periods in the case of nested fields. In
some cases this may come back as “null” if the error is
not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed
immediately by changing the data you sent in the request,
but in some cases you will be instructed to Open a support
ticket
or perform some other action before you can complete the
request successfully.
