Account

This section details Account-related Linode CLI commands.

view

Returns the contact and billing information related to your Account.

Usage

The format accepted by this command.

linode-cli account view [-h] [--order-by {}] [--order {asc,desc}]

Sample

Examples of how this command might be used.

linode-cli account view

Result Attributes

The attributes returned by this command.

Name

Type

Example

Description

active_since

str

2018-01-01T00:01:01

The date and time the account was activated.

address_1

str

123 Main Street

First line of this Account’s billing address.

address_2

str

Suite A

Second line of this Account’s billing address.

balance

float

200

This Account’s balance, in US dollars.

balance_uninvoiced

float

145

This Account’s current estimated invoice in US dollars.

billing_source

str

akamai

The source of service charges for this Account, as determined by its relationship with Akamai.

capabilities

[]str

[“Linodes”, “…ent Groups”]

A list of capabilities your account supports.

city

str

Philadelphia

The city for this Account’s billing address.

company

str

Linode LLC

The company name associated with this Account.

country

str

US

The two-letter ISO 3166 country code of this Account’s billing address.

email

str

john.smith@linode.com

The email address of the person associated with this Account.

euuid

str

E1AF5EEC-526F…EBEB34C87D71

An external unique identifier for this account.

first_name

str

John

The first name of the person associated with this Account.

last_name

str

Smith

The last name of the person associated with this Account.

phone

str

215-555-1212

The phone number associated with this Account.

state

str

PA

If billing address is in the United States (US) or Canada (CA), only the two-letter ISO 3166 State or Province code are accepted.

tax_id

str

ATU99999999

The tax identification number associated with this Account, for tax calculations in some countries.

zip

str

19102-1234

The zip code of this Account’s billing address.

active_promotions

Name

Type

Example

Description

active_promotions.credit_monthly_cap

str

10.00

The amount available to spend per month.

active_promotions.credit_remaining

str

50.00

The total amount of credit left for this promotion.

active_promotions.description

str

Receive up to…period ends.

A detailed description of this promotion.

active_promotions.expire_dt

str

2018-01-31T23:59:59

When this promotion’s credits expire.

active_promotions.image_url

str

https://linod…romotion.svg

The location of an image for this promotion.

active_promotions.service_type

str

all

The service to which this promotion applies.

active_promotions.summary

str

$10 off your…ode a month!

Short details of this promotion.

active_promotions.this_month_credit_remaining

str

10.00

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

credit_card

Name

Type

Example

Description

credit_card.expiry

str

11/2022

The expiration month and year of the credit card.

credit_card.last_four

str

1111

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


update

Updates contact and billing information related to your account.

Usage

The format accepted by this command.

linode-cli account update [-h] [--city city] [--state state]
    [--first_name first_name] [--zip zip] [--address_2 address_2]
    [--company company]
    [--active_promotions.service_type service_type]
    [--active_promotions.this_month_credit_remaining this_month_credit_remaining]
    [--active_promotions.expire_dt expire_dt]
    [--active_promotions.summary summary]
    [--active_promotions.credit_monthly_cap credit_monthly_cap]
    [--active_promotions.credit_remaining credit_remaining]
    [--active_promotions.image_url image_url]
    [--active_promotions.description description] [--phone phone]
    [--tax_id tax_id] [--email email] [--country country]
    [--last_name last_name] [--address_1 address_1]

Sample

Examples of how this command might be used.

linode-cli account update \
    --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

Arguments

Additional fields used to execute this request.

Name

Type

Example

Description

--address_1

str

123 Main Street

First line of this Account’s billing address.

--address_2

str

Suite A

Second line of this Account’s billing address.

--city

str

Philadelphia

The city for this Account’s billing address.

--company

str

Linode LLC

The company name associated with this Account.

--country

str

US

The two-letter ISO 3166 country code of this Account’s billing address.

--email

str

john.smith@linode.com

The email address of the person associated with this Account.

--first_name

str

John

The first name of the person associated with this Account.

--last_name

str

Smith

The last name of the person associated with this Account.

--phone

str

215-555-1212

The phone number associated with this Account.

--state

str

PA

If billing address is in the United States (US) or Canada (CA), only the two-letter ISO 3166 State or Province code are accepted.

--tax_id

str

ATU99999999

The tax identification number associated with this Account, for tax calculations in some countries.

--zip

str

19102-1234

The zip code of this Account’s billing address.

active_promotions

Name

Type

Example

Description

--active_promotions.credit_monthly_cap

str

10.00

The amount available to spend per month.

--active_promotions.credit_remaining

str

50.00

The total amount of credit left for this promotion.

--active_promotions.description

str

Receive up to…period ends.

A detailed description of this promotion.

--active_promotions.expire_dt

str

2018-01-31T23:59:59

When this promotion’s credits expire.

--active_promotions.image_url

str

https://linod…romotion.svg

The location of an image for this promotion.

--active_promotions.service_type

str

all

The service to which this promotion applies.

--active_promotions.summary

str

$10 off your…ode a month!

Short details of this promotion.

--active_promotions.this_month_credit_remaining

str

10.00

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

Result Attributes

The attributes returned by this command.

Name

Type

Example

Description

active_since

str

2018-01-01T00:01:01

The date and time the account was activated.

address_1

str

123 Main Street

First line of this Account’s billing address.

address_2

str

Suite A

Second line of this Account’s billing address.

balance

float

200

This Account’s balance, in US dollars.

balance_uninvoiced

float

145

This Account’s current estimated invoice in US dollars.

billing_source

str

akamai

The source of service charges for this Account, as determined by its relationship with Akamai.

capabilities

[]str

[“Linodes”, “…ent Groups”]

A list of capabilities your account supports.

city

str

Philadelphia

The city for this Account’s billing address.

company

str

Linode LLC

The company name associated with this Account.

country

str

US

The two-letter ISO 3166 country code of this Account’s billing address.

email

str

john.smith@linode.com

The email address of the person associated with this Account.

euuid

str

E1AF5EEC-526F…EBEB34C87D71

An external unique identifier for this account.

first_name

str

John

The first name of the person associated with this Account.

last_name

str

Smith

The last name of the person associated with this Account.

phone

str

215-555-1212

The phone number associated with this Account.

state

str

PA

If billing address is in the United States (US) or Canada (CA), only the two-letter ISO 3166 State or Province code are accepted.

tax_id

str

ATU99999999

The tax identification number associated with this Account, for tax calculations in some countries.

zip

str

19102-1234

The zip code of this Account’s billing address.

active_promotions

Name

Type

Example

Description

active_promotions.credit_monthly_cap

str

10.00

The amount available to spend per month.

active_promotions.credit_remaining

str

50.00

The total amount of credit left for this promotion.

active_promotions.description

str

Receive up to…period ends.

A detailed description of this promotion.

active_promotions.expire_dt

str

2018-01-31T23:59:59

When this promotion’s credits expire.

active_promotions.image_url

str

https://linod…romotion.svg

The location of an image for this promotion.

active_promotions.service_type

str

all

The service to which this promotion applies.

active_promotions.summary

str

$10 off your…ode a month!

Short details of this promotion.

active_promotions.this_month_credit_remaining

str

10.00

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

credit_card

Name

Type

Example

Description

credit_card.expiry

str

11/2022

The expiration month and year of the credit card.

credit_card.last_four

str

1111

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


cancel

Cancels an active Linode account.

Usage

The format accepted by this command.

linode-cli account cancel [-h] [--comments comments]

Sample

Examples of how this command might be used.

linode-cli account cancel \
    --comments "I'm consolidating my accounts"

Arguments

Additional fields used to execute this request.

Name

Type

Example

Description

--comments

str

I’m consolida…ts into one.

Any reason for cancelling the account, and any other comments you might have about your Linode service.

Result Attributes

The attributes returned by this command.

Name

Type

Example

Description

survey_link

str

N/A

A link to Linode’s exit survey.


settings

Returns information related to your Account settings: Managed service subscription, Longview subscription, and network helper.

Usage

The format accepted by this command.

linode-cli account settings [-h] [--order-by {}]
    [--order {asc,desc}]

Sample

Examples of how this command might be used.

linode-cli account settings

Result Attributes

The attributes returned by this command.

Name

Type

Example

Description

backups_enabled

bool

true

Account-wide backups default.

longview_subscription

str

longview-3

The Longview Pro tier you are currently subscribed to.

managed

bool

true

Our 24/7 incident response service.

network_helper

bool

N/A

Enables network helper across all users by default for new Linodes and Linode Configs.

object_storage

str

active

A string describing the status of this account’s Object Storage service enrollment.


transfer

Returns a Transfer object showing your network utilization, in GB, for the current month.

Usage

The format accepted by this command.

linode-cli account transfer [-h] [--order-by {}]
    [--order {asc,desc}]

Sample

Examples of how this command might be used.

linode-cli account transfer

Result Attributes

The attributes returned by this command.

Name

Type

Example

Description

billable

int

N/A

The amount of your transfer pool that is billable this billing cycle.

quota

int

9141

The amount of network usage allowed this billing cycle.

used

int

2

The amount of network usage you have used this billing cycle.

region_transfers

Name

Type

Example

Description

region_transfers.billable

int

N/A

The amount of your transfer pool that is billable this billing cycle for this Region.

region_transfers.id

str

us-east

The Region ID for this network utilization data.

region_transfers.quota

int

5010

The amount of network usage allowed this billing cycle for this Region.

region_transfers.used

int

1

The amount of network usage you have used this billing cycle for this Region.


client-view

Returns information about a single OAuth client.

Usage

The format accepted by this command.

linode-cli account client-view [-h] [--label label]
    [--public public] [--order-by {label,public}]
    [--order {asc,desc}] clientId

Sample

Examples of how this command might be used.

linode-cli account client-view \
    edc6790ea9db4d224c5c

Parameters

Positional parameters used to define the resource this command should target.

Name

Type

Description

clientId

str

The OAuth Client ID to look up.

Result Attributes

The attributes returned by this command.

Name

Type

Example

Description

id

str

2737bf16b39ab5d7b4a1

The OAuth Client ID.

label

str

Test_Client_1

The name of this application.

public

bool

N/A

If this is a public or private OAuth Client.

redirect_uri

str

https://exam…uth/callback

The location a successful log in from login.linode.com should be redirected to for this client.

secret

str

<REDACTED>

The OAuth Client secret, used in the OAuth exchange.

status

str

active

The status of this application.

thumbnail_url

str

https://api….a1/thumbnail

The URL where this client’s thumbnail may be viewed, or null if this client does not have a thumbnail set.


client-create

Creates an OAuth Client, which can be used to allow users (using their Linode account) to log in to your own application, and optionally grant your application some amount of access to their Linodes or other entities.

Usage

The format accepted by this command.

linode-cli account client-create [-h]
    [--redirect_uri redirect_uri] [--public public]
    [--label label]

Sample

Examples of how this command might be used.

linode-cli account client-create \
    --label Test_Client_1 \
    --redirect_uri https://example.org/callback

Arguments

Additional fields used to execute this request.

Name

Type

Example

Description

--label *

str

Test_Client_1

The name of this application.

--redirect_uri *

str

https://exam…uth/callback

The location a successful log in from login.linode.com should be redirected to for this client.

--public

bool

N/A

If this is a public or private OAuth Client.

Result Attributes

The attributes returned by this command.

Name

Type

Example

Description

id

str

2737bf16b39ab5d7b4a1

The OAuth Client ID.

label

str

Test_Client_1

The name of this application.

public

bool

N/A

If this is a public or private OAuth Client.

redirect_uri

str

https://exam…uth/callback

The location a successful log in from login.linode.com should be redirected to for this client.

secret

str

<REDACTED>

The OAuth Client secret, used in the OAuth exchange.

status

str

active

The status of this application.

thumbnail_url

str

https://api….a1/thumbnail

The URL where this client’s thumbnail may be viewed, or null if this client does not have a thumbnail set.


client-update

Update information about an OAuth Client on your Account.

Usage

The format accepted by this command.

linode-cli account client-update [-h] [--label label]
    [--public public] [--redirect_uri redirect_uri] clientId

Sample

Examples of how this command might be used.

linode-cli account client-update \
    edc6790ea9db4d224c5c \
    --label Test_Client_1

Parameters

Positional parameters used to define the resource this command should target.

Name

Type

Description

clientId

str

The OAuth Client ID to look up.

Arguments

Additional fields used to execute this request.

Name

Type

Example

Description

--label

str

Test_Client_1

The name of this application.

--public

bool

N/A

If this is a public or private OAuth Client.

--redirect_uri

str

https://exam…uth/callback

The location a successful log in from login.linode.com should be redirected to for this client.

Result Attributes

The attributes returned by this command.

Name

Type

Example

Description

id

str

2737bf16b39ab5d7b4a1

The OAuth Client ID.

label

str

Test_Client_1

The name of this application.

public

bool

N/A

If this is a public or private OAuth Client.

redirect_uri

str

https://exam…uth/callback

The location a successful log in from login.linode.com should be redirected to for this client.

secret

str

<REDACTED>

The OAuth Client secret, used in the OAuth exchange.

status

str

active

The status of this application.

thumbnail_url

str

https://api….a1/thumbnail

The URL where this client’s thumbnail may be viewed, or null if this client does not have a thumbnail set.


client-delete

Deletes an OAuth Client registered with Linode.

Usage

The format accepted by this command.

linode-cli account client-delete [-h] clientId

Sample

Examples of how this command might be used.

linode-cli account client-delete \
    edc6790ea9db4d224c5c

Parameters

Positional parameters used to define the resource this command should target.

Name

Type

Description

clientId

str

The OAuth Client ID to look up.


client-reset-secret

Resets the OAuth Client secret for a client you own, and returns the OAuth Client with the plaintext secret.

Usage

The format accepted by this command.

linode-cli account client-reset-secret [-h] clientId

Sample

Examples of how this command might be used.

linode-cli account client-reset-secret \
    edc6790ea9db4d224c5c

Parameters

Positional parameters used to define the resource this command should target.

Name

Type

Description

clientId

str

The OAuth Client ID to look up.

Result Attributes

The attributes returned by this command.

Name

Type

Example

Description

id

str

2737bf16b39ab5d7b4a1

The OAuth Client ID.

label

str

Test_Client_1

The name of this application.

public

bool

N/A

If this is a public or private OAuth Client.

redirect_uri

str

https://exam…uth/callback

The location a successful log in from login.linode.com should be redirected to for this client.

secret

str

<REDACTED>

The OAuth Client secret, used in the OAuth exchange.

status

str

active

The status of this application.

thumbnail_url

str

https://api….a1/thumbnail

The URL where this client’s thumbnail may be viewed, or null if this client does not have a thumbnail set.


clients-list

Returns a paginated list of OAuth Clients registered to your Account.

Usage

The format accepted by this command.

linode-cli account clients-list [-h] [--label label]
    [--public public] [--order-by {label,public}]
    [--order {asc,desc}]

Sample

Examples of how this command might be used.

linode-cli account clients-list

Filterable Attributes

Arguments used to define a filter for response entries.

Name

Type

Description

--label

str

The name of this application.

--public

bool

If this is a public or private OAuth Client.

Result Attributes

The attributes returned by this command.

Name

Type

Example

Description

id

str

2737bf16b39ab5d7b4a1

The OAuth Client ID.

label

str

Test_Client_1

The name of this application.

public

bool

N/A

If this is a public or private OAuth Client.

redirect_uri

str

https://exam…uth/callback

The location a successful log in from login.linode.com should be redirected to for this client.

secret

str

<REDACTED>

The OAuth Client secret, used in the OAuth exchange.

status

str

active

The status of this application.

thumbnail_url

str

https://api….a1/thumbnail

The URL where this client’s thumbnail may be viewed, or null if this client does not have a thumbnail set.


enable-managed

Enables Linode Managed for the entire account and sends a welcome email to the account’s associated email address.

Usage

The format accepted by this command.

linode-cli account enable-managed [-h]

Sample

Examples of how this command might be used.

linode-cli account enable-managed

get-account-availability

View the available services for your account in a specific region.

Usage

The format accepted by this command.

linode-cli account get-account-availability [-h] [--order-by {}]
    [--order {asc,desc}] id

Sample

Examples of how this command might be used.

linode-cli account get-account-availability us-east

Parameters

Positional parameters used to define the resource this command should target.

Name

Type

Description

id

str

The slug for the applicable data center.

Result Attributes

The attributes returned by this command.

Name

Type

Example

Description

available

[]str

[“Linodes”, …eBalancers”]

A list of services _available_ to your account in the region.

region

str

us-east

The Akamai cloud computing data center (region), represented by a slug value.

unavailable

[]str

[“Kubernetes”…ck Storage”]

A list of services _unavailable_ to your account in the region.


get-availability

Returns a paginated list of the services available to you, for all Linode regions.

Usage

The format accepted by this command.

linode-cli account get-availability [-h] [--order-by {}]
    [--order {asc,desc}]

Sample

Examples of how this command might be used.

linode-cli account get-availability

Result Attributes

The attributes returned by this command.

Name

Type

Example

Description

available

[]str

[“Linodes”, …eBalancers”]

A list of services _available_ to your account in the region.

region

str

us-east

The Akamai cloud computing data center (region), represented by a slug value.

unavailable

[]str

[“Kubernetes”…ck Storage”]

A list of services _unavailable_ to your account in the region.


invoice-view

Returns a single Invoice object.

Usage

The format accepted by this command.

linode-cli account invoice-view [-h] [--label label]
    [--total total] [--date date]
    [--billing_source billing_source]
    [--order-by {label,total,date,billing_source}]
    [--order {asc,desc}] invoiceId

Sample

Examples of how this command might be used.

linode-cli account invoice-view 123

Parameters

Positional parameters used to define the resource this command should target.

Name

Type

Description

invoiceId

int

The ID of the Invoice.

Result Attributes

The attributes returned by this command.

Name

Type

Example

Description

billing_source

str

linode

akamai: This Invoice was generated according to the terms of an agreement between the customer and Akamai.

date

str

2018-01-01T00:01:01

When this Invoice was generated.

id

int

123

The Invoice’s unique ID.

label

str

Invoice

The Invoice’s display label.

subtotal

float

120.25

The amount of the Invoice before taxes in US Dollars.

tax

float

12.25

The amount of tax levied on the Invoice in US Dollars.

total

float

132.5

The amount of the Invoice after taxes in US Dollars.

tax_summary

Name

Type

Example

Description

tax_summary.name

str

PA STATE TAX

The source of this tax subtotal.

tax_summary.tax

float

12.25

The amount of tax subtotal attributable to this source.


invoice-items

Returns a paginated list of Invoice items.

Usage

The format accepted by this command.

linode-cli account invoice-items [-h] [--order-by {}]
    [--order {asc,desc}] invoiceId

Sample

Examples of how this command might be used.

linode-cli account invoice-items 123

Parameters

Positional parameters used to define the resource this command should target.

Name

Type

Description

invoiceId

int

The ID of the Invoice.

Result Attributes

The attributes returned by this command.

Name

Type

Example

Description

amount

float

20.2

The price, in US dollars, of the Invoice Item.

from

str

2018-01-01T00:01:01

The date the Invoice Item started, based on month.

label

str

Linode 123

The Invoice Item’s display label.

quantity

int

4

The quantity of this Item for the specified Invoice.

region

str

us-west

The ID of the applicable Region associated with this Invoice Item.

tax

float

1.25

The amount of tax levied on this Item in US Dollars.

to

str

2018-01-31T11:59:59

The date the Invoice Item ended, based on month.

total

float

21.45

The price of this Item after taxes in US Dollars.

type

str

hourly

The type of service, ether hourly or misc.

unit_price

str

5.05

The monthly service fee in US Dollars for this Item.


invoices-list

Returns a paginated list of Invoices against your Account.

Usage

The format accepted by this command.

linode-cli account invoices-list [-h] [--total total]
    [--date date] [--billing_source billing_source]
    [--label label]
    [--order-by {total,date,billing_source,label}]
    [--order {asc,desc}]

Sample

Examples of how this command might be used.

linode-cli account invoices-list

Filterable Attributes

Arguments used to define a filter for response entries.

Name

Type

Description

--billing_source

str

akamai: This Invoice was generated according to the terms of an agreement between the customer and Akamai.

--date

str

When this Invoice was generated.

--label

str

The Invoice’s display label.

--total

float

The amount of the Invoice after taxes in US Dollars.

Result Attributes

The attributes returned by this command.

Name

Type

Example

Description

billing_source

str

linode

akamai: This Invoice was generated according to the terms of an agreement between the customer and Akamai.

date

str

2018-01-01T00:01:01

When this Invoice was generated.

id

int

123

The Invoice’s unique ID.

label

str

Invoice

The Invoice’s display label.

subtotal

float

120.25

The amount of the Invoice before taxes in US Dollars.

tax

float

12.25

The amount of tax levied on the Invoice in US Dollars.

total

float

132.5

The amount of the Invoice after taxes in US Dollars.

tax_summary

Name

Type

Example

Description

tax_summary.name

str

PA STATE TAX

The source of this tax subtotal.

tax_summary.tax

float

12.25

The amount of tax subtotal attributable to this source.


login-view

Returns a Login object that displays information about a successful login.

Usage

The format accepted by this command.

linode-cli account login-view [-h] [--order-by {}]
    [--order {asc,desc}] loginId

Sample

Examples of how this command might be used.

linode-cli account login-view 1234

Parameters

Positional parameters used to define the resource this command should target.

Name

Type

Description

loginId

int

The ID of the login object to access.

Result Attributes

The attributes returned by this command.

Name

Type

Example

Description

datetime

str

2018-01-01T00:01:01

When the login was initiated.

id

int

1234

The unique ID of this login object.

ip

str

192.0.2.0

The remote IP address that requested the login.

restricted

bool

true

True if the User that attempted the login was a restricted User, false otherwise.

status

str

successful

Whether the login attempt succeeded or failed.

username

str

example_user

The username of the User that attempted the login.


logins-list

Returns a collection of successful logins for all users on the account during the last 90 days.

Usage

The format accepted by this command.

linode-cli account logins-list [-h] [--order-by {}]
    [--order {asc,desc}]

Sample

Examples of how this command might be used.

linode-cli account logins-list

Result Attributes

The attributes returned by this command.

Name

Type

Example

Description

datetime

str

2018-01-01T00:01:01

When the login was initiated.

id

int

1234

The unique ID of this login object.

ip

str

192.0.2.0

The remote IP address that requested the login.

restricted

bool

true

True if the User that attempted the login was a restricted User, false otherwise.

status

str

successful

Whether the login attempt succeeded or failed.

username

str

example_user

The username of the User that attempted the login.


maintenance-list

Returns a collection of Maintenance objects for any entity a user has permissions to view.

Usage

The format accepted by this command.

linode-cli account maintenance-list [-h] [--type type]
    [--when when] [--status status]
    [--order-by {type,when,status}] [--order {asc,desc}]

Sample

Examples of how this command might be used.

linode-cli account maintenance-list

Filterable Attributes

Arguments used to define a filter for response entries.

Name

Type

Description

--status

str

The maintenance status.

--type

str

The type of maintenance.

--when

str

When the maintenance will begin.

Result Attributes

The attributes returned by this command.

Name

Type

Example

Description

reason

str

This mainten…motherboard.

The reason maintenance is being performed.

status

str

started

The maintenance status.

type

str

reboot

The type of maintenance.

when

str

2020-07-09T00:01:01

When the maintenance will begin.

entity

Name

Type

Example

Description

entity.id

float

1234

The id of the entity being affected by maintenance.

entity.label

str

demo-linode

The label of the entity being affected by maintenance.

entity.type

str

Linode

The type of entity.

entity.url

str

https://api.l…s/{linodeId}

The API endpoint prefix to use in combination with the entity id to find specific information about the entity.


notifications-list

Returns a collection of Notification objects representing important, often time-sensitive items related to your Account.

Usage

The format accepted by this command.

linode-cli account notifications-list [-h] [--order-by {}]
    [--order {asc,desc}]

Sample

Examples of how this command might be used.

linode-cli account notifications-list

Result Attributes

The attributes returned by this command.

Name

Type

Example

Description

body

str

N/A

A full description of this Notification, in markdown format.

label

str

You have an …ticket open!

A short description of this Notification.

message

str

You have an …ticket open!

A human-readable description of the Notification.

severity

str

major

The severity of this Notification.

type

str

ticket_important

The type of Notification this is.

until

str

N/A

If this Notification has a duration, this will be the ending time for the Event/action.

when

str

N/A

If this Notification is of an Event that will happen at a fixed, future time, this is when the named action will be taken.

entity

Name

Type

Example

Description

entity.id

int

3456

The unique ID of the Notification’s entity, based on the entity type.

entity.label

str

Linode not booting.

The current label for this Notification’s entity.

entity.type

str

ticket

The type of entity this is related to.

entity.url

str

/support/tickets/3456

The URL where you can access the object this Notification is for.


payment-view

Returns information about a specific Payment.

Usage

The format accepted by this command.

linode-cli account payment-view [-h] [--order-by {}]
    [--order {asc,desc}] paymentId

Sample

Examples of how this command might be used.

linode-cli account payment-view 123

Parameters

Positional parameters used to define the resource this command should target.

Name

Type

Description

paymentId

int

The ID of the Payment to look up.

Result Attributes

The attributes returned by this command.

Name

Type

Example

Description

date

str

2018-01-15T00:01:01

When the Payment was made.

id

int

123

The unique ID of the Payment.

usd

int

120.50

The amount, in US dollars, of the Payment.


payment-create

Makes a Payment to your Account.

Usage

The format accepted by this command.

linode-cli account payment-create [-h] [--usd usd]
    [--payment_method_id payment_method_id]

Sample

Examples of how this command might be used.

linode-cli account payment-create \
    --usd 120.50 \
    --payment_method_id 123

Arguments

Additional fields used to execute this request.

Name

Type

Example

Description

--payment_method_id

int

123

The ID of the Payment Method to apply to the Payment.

--usd

str

$120.50

The amount in US Dollars of the Payment.

Result Attributes

The attributes returned by this command.

Name

Type

Example

Description

date

str

2018-01-15T00:01:01

When the Payment was made.

id

int

123

The unique ID of the Payment.

usd

int

120.50

The amount, in US dollars, of the Payment.


payments-list

Returns a paginated list of Payments made on this Account.

Usage

The format accepted by this command.

linode-cli account payments-list [-h] [--order-by {}]
    [--order {asc,desc}]

Sample

Examples of how this command might be used.

linode-cli account payments-list

Result Attributes

The attributes returned by this command.

Name

Type

Example

Description

date

str

2018-01-15T00:01:01

When the Payment was made.

id

int

123

The unique ID of the Payment.

usd

int

120.50

The amount, in US dollars, of the Payment.


promo-add

Adds an expiring Promo Credit to your account.

Usage

The format accepted by this command.

linode-cli account promo-add [-h] [--promo_code promo_code]

Sample

Examples of how this command might be used.

linode-cli account \
    promo-add \
    --promo-code abcdefABCDEF1234567890

Arguments

Additional fields used to execute this request.

Name

Type

Example

Description

--promo_code *

str

N/A

The Promo Code.

Result Attributes

The attributes returned by this command.

Name

Type

Example

Description

credit_monthly_cap

str

10.00

The amount available to spend per month.

credit_remaining

str

50.00

The total amount of credit left for this promotion.

description

str

Receive up to…period ends.

A detailed description of this promotion.

expire_dt

str

2018-01-31T23:59:59

When this promotion’s credits expire.

image_url

str

https://linod…romotion.svg

The location of an image for this promotion.

service_type

str

all

The service to which this promotion applies.

summary

str

$10 off your…ode a month!

Short details of this promotion.

this_month_credit_remaining

str

10.00

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

settings-update

Updates your account settings.

Usage

The format accepted by this command.

linode-cli account settings-update [-h]
    [--backups_enabled backups_enabled]
    [--network_helper network_helper]

Sample

Examples of how this command might be used.

linode-cli account settings-update \
    --network_helper false

Arguments

Additional fields used to execute this request.

Name

Type

Example

Description

--backups_enabled

bool

true

Account-wide backups default.

--network_helper

bool

N/A

Enables network helper across all users by default for new Linodes and Linode Configs.

Result Attributes

The attributes returned by this command.

Name

Type

Example

Description

backups_enabled

bool

true

Account-wide backups default.

longview_subscription

str

longview-3

The Longview Pro tier you are currently subscribed to.

managed

bool

true

Our 24/7 incident response service.

network_helper

bool

N/A

Enables network helper across all users by default for new Linodes and Linode Configs.

object_storage

str

active

A string describing the status of this account’s Object Storage service enrollment.