Payment Methods
This section details Payment Method-related Linode CLI commands.
list
Aliases: ls
Returns a paginated list of Payment Methods for this Account.
Usage
The format accepted by this command.
linode-cli payment-methods list [-h] [--order-by {}]
[--order {asc,desc}]
Sample
Examples of how this command might be used.
linode-cli payment-methods list
Result Attributes
The attributes returned by this command.
Name |
Type |
Example |
Description |
---|---|---|---|
created |
str |
2018-01-15T00:01:01 |
When the Payment Method was added to the Account. |
data |
str |
N/A |
N/A |
id |
int |
123 |
The unique ID of this Payment Method. |
is_default |
bool |
true |
Whether this Payment Method is the default method for automatically processing service charges. |
type |
str |
credit_card |
The type of Payment Method. |
view
View the details of the specified Payment Method.
Usage
The format accepted by this command.
linode-cli payment-methods view [-h] [--order-by {}]
[--order {asc,desc}] paymentMethodId
Sample
Examples of how this command might be used.
linode-cli payment-methods view 123
Parameters
Positional parameters used to define the resource this command should target.
Name |
Type |
Description |
---|---|---|
paymentMethodId |
int |
The ID of the Payment Method to look up. |
Result Attributes
The attributes returned by this command.
Name |
Type |
Example |
Description |
---|---|---|---|
created |
str |
2018-01-15T00:01:01 |
When the Payment Method was added to the Account. |
data |
str |
N/A |
N/A |
id |
int |
123 |
The unique ID of this Payment Method. |
is_default |
bool |
true |
Whether this Payment Method is the default method for automatically processing service charges. |
type |
str |
credit_card |
The type of Payment Method. |
add
Adds a Payment Method to your Account with the option to set it as the default method.
Usage
The format accepted by this command.
linode-cli payment-methods add [-h] [--is_default is_default]
[--data.expiry_year expiry_year] [--data.cvv cvv]
[--data.card_number card_number]
[--data.expiry_month expiry_month] [--type type]
Sample
Examples of how this command might be used.
linode-cli payment-methods add \
--type credit_card \
--is_default true \
--data.card_number 4111111111111111 \
--data.expiry_month 11 \
--data.expiry_year 2020 \
--data.cvv 111
Arguments
Additional fields used to execute this request.
Name |
Type |
Example |
Description |
---|---|---|---|
--is_default * |
bool |
true |
Whether this Payment Method is the default method for automatically processing service charges. |
--type * |
str |
credit_card |
The type of Payment Method. |
--data.card_number * |
str |
4111111111111111 |
Your credit card number. |
--data.cvv * |
str |
123 |
CVV (Card Verification Value) of the credit card, typically found on the back of the card. |
--data.expiry_month * |
int |
12 |
A value from 1-12 representing the expiration month of your credit card. |
--data.expiry_year * |
int |
2020 |
A four-digit integer representing the expiration year of your credit card. |
delete
Aliases: rm
Deactivate the specified Payment Method.
Usage
The format accepted by this command.
linode-cli payment-methods delete [-h] paymentMethodId
Sample
Examples of how this command might be used.
linode-cli payment-methods delete 123
Parameters
Positional parameters used to define the resource this command should target.
Name |
Type |
Description |
---|---|---|
paymentMethodId |
int |
The ID of the Payment Method to look up. |
default
Make the specified Payment Method the default method for automatically processing payments.
Usage
The format accepted by this command.
linode-cli payment-methods default [-h] paymentMethodId
Sample
Examples of how this command might be used.
linode-cli payment-methods default 123
Parameters
Positional parameters used to define the resource this command should target.
Name |
Type |
Description |
---|---|---|
paymentMethodId |
int |
The ID of the Payment Method to make default. |