Account

View Account

get
https://api.linode.com/v4/account

Returns the contact and billing information related to your Account.

Authorizations

Personal Access Token
OAuth: ( account:read_only)

Request Samples

curl -H "Authorization: Bearer $TOKEN" \
    https://api.linode.com/v4/account

Response Samples

{
  "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",
      "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,
  "capabilities": [],
  "city": "Philadelphia",
  "credit_card": {
    "last_four": 1111,
    "expiry": "11/2022"
  },
  "company": "Linode LLC",
  "country": "US",
  "email": "john.smith@linode.com",
  "first_name": "John",
  "last_name": "Smith",
  "phone": "215-555-1212",
  "state": "Pennsylvania",
  "tax_id": "ATU99999999",
  "zip": 19102
}

Responses

200: Returns a single Account object.

active_promotions
array of objects
credit_monthly_cap
string

The amount available to spend per month.

credit_remaining
string

The total amount of credit left for this promotion.

description
string

A detailed description of this promotion.

expire_dt
string

When this promotion's credits expire.

image_url
string

The location of an image for this promotion.

summary
string

Short details of this promotion.

this_month_credit_remaining
string

The amount of credit left for this month for this promotion.

active_since
string <date-time>

The datetime of when the account was activated.

address_1
string <= 64 characters

First line of this Account's billing address.

address_2
string <= 64 characters

Second line of this Account's billing address.

balance
number

This Account's balance, in US dollars.

balance_uninvoiced
number

This Account's current estimated invoice in US dollars. This is not your final invoice balance. Bandwidth charges are not included in the estimate.

capabilities
array of objects

A list of capabilities your account supports.

city
string <= 24 characters

The city for this Account's billing address.

credit_card
object

Credit Card information associated with this Account.

last_four
string

The last four digits of the credit card associated with this Account.

expiry
string

The expiration month and year of the credit card.

company
string <= 128 characters

The company name associated with this Account.

country
string 2 characters

The two-letter country code of this Account's billing address.

email
string <= 128 characters

The email address of the person associated with this Account.

first_name
string <= 50 characters

The first name of the person associated with this Account.

last_name
string <= 50 characters

The last name of the person associated with this Account.

phone
string <= 32 characters

The phone number associated with this Account.

state
string <= 24 characters

If billing address is in the United States, this is the State portion of the Account's billing address. If the address is outside the US, this is the Province associated with the Account's billing address.

tax_id
string <= 100 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 null.

zip
string <= 16 characters

The zip code of this Account's billing address.

default: Error

errors
array of objects
reason
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.

field
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.

Update Account

put
https://api.linode.com/v4/account

Updates contact and billing information related to your Account.

Authorizations

Personal Access Token
OAuth: ( account:read_write)

Request Body Schema

active_promotions
array
address_1
string <= 64 characters

First line of this Account's billing address.

address_2
string <= 64 characters

Second line of this Account's billing address.

city
string <= 24 characters

The city for this Account's billing address.

company
string <= 128 characters

The company name associated with this Account.

country
string 2 characters

The two-letter country code of this Account's billing address.

email
string <= 128 characters

The email address of the person associated with this Account.

first_name
string <= 50 characters

The first name of the person associated with this Account.

last_name
string <= 50 characters

The last name of the person associated with this Account.

phone
string <= 32 characters

The phone number associated with this Account.

state
string <= 24 characters

If billing address is in the United States, this is the State portion of the Account's billing address. If the address is outside the US, this is the Province associated with the Account's billing address.

tax_id
string <= 100 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 null.

zip
string <= 16 characters

The zip code of this Account's billing address.

Request Samples

curl -H "Content-Type: application/json" \
    -H "Authorization: Bearer $TOKEN" \
    -X PUT -d '{
      "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",
      "zip": 19102,
      }
    }' \
    https://api.linode.com/v4/account

Response Samples

{
  "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",
      "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,
  "capabilities": [],
  "city": "Philadelphia",
  "credit_card": {
    "last_four": 1111,
    "expiry": "11/2022"
  },
  "company": "Linode LLC",
  "country": "US",
  "email": "john.smith@linode.com",
  "first_name": "John",
  "last_name": "Smith",
  "phone": "215-555-1212",
  "state": "Pennsylvania",
  "tax_id": "ATU99999999",
  "zip": 19102
}

Responses

200: The updated Account.

active_promotions
array of objects
credit_monthly_cap
string

The amount available to spend per month.

credit_remaining
string

The total amount of credit left for this promotion.

description
string

A detailed description of this promotion.

expire_dt
string

When this promotion's credits expire.

image_url
string

The location of an image for this promotion.

summary
string

Short details of this promotion.

this_month_credit_remaining
string

The amount of credit left for this month for this promotion.

active_since
string <date-time>

The datetime of when the account was activated.

address_1
string <= 64 characters

First line of this Account's billing address.

address_2
string <= 64 characters

Second line of this Account's billing address.

balance
number

This Account's balance, in US dollars.

balance_uninvoiced
number

This Account's current estimated invoice in US dollars. This is not your final invoice balance. Bandwidth charges are not included in the estimate.

capabilities
array of objects

A list of capabilities your account supports.

city
string <= 24 characters

The city for this Account's billing address.

credit_card
object

Credit Card information associated with this Account.

last_four
string

The last four digits of the credit card associated with this Account.

expiry
string

The expiration month and year of the credit card.

company
string <= 128 characters

The company name associated with this Account.

country
string 2 characters

The two-letter country code of this Account's billing address.

email
string <= 128 characters

The email address of the person associated with this Account.

first_name
string <= 50 characters

The first name of the person associated with this Account.

last_name
string <= 50 characters

The last name of the person associated with this Account.

phone
string <= 32 characters

The phone number associated with this Account.

state
string <= 24 characters

If billing address is in the United States, this is the State portion of the Account's billing address. If the address is outside the US, this is the Province associated with the Account's billing address.

tax_id
string <= 100 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 null.

zip
string <= 16 characters

The zip code of this Account's billing address.

default: Error

errors
array of objects
reason
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.

field
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.