payment_methods

Creates, updates, deletes, gets or lists a payment_methods resource.

Overview

Name	payment_methods
Type	Resource
Id	linode.account.payment_methods

Fields

The following fields are returned by SELECT queries:

get_payment_method

Returns a Payment Method Object.

Name	Datatype	Description
id	integer	The unique ID of this Payment Method.
created	string (date-time)	Read-only When the Payment Method was added to the Account. (example: 2018-01-15T00:01:01)
data		(x-linode-cli-format: json)
is_default	boolean	Whether this Payment Method is the default method for automatically processing service charges.
type	string	The type of Payment Method. (example: credit_card)

get_payment_methods

Returns a paginated list of Payment Method objects.

Name	Datatype	Description
data	array
page	integer	Read-only The current page.
pages	integer	Read-only The total number of pages.
results	integer	Read-only The total number of results.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_payment_method	select			View the details of the specified Payment Method. Learn more... Learn more...
get_payment_methods	select		page, page_size	Returns a paginated list of Payment Methods for this Account. Learn more... Learn more...
post_payment_method	insert	data__type, data__data, data__is_default		Adds a Payment Method to your Account with the option to set it as the default method. - Adding a default Payment Method removes the default status from any other Payment Method. - An Account can have up to 6 active Payment Methods. - Up to 60 Payment Methods can be added each day. - Prior to adding a Payment Method, ensure that your billing address information is up-to-date with a valid zip by running the Update your account operation. - A payment_method_add event is generated when a payment is successfully submitted. Parent and child accounts In a parent and child account environment, the following apply: - Child account users can't run this operation. These users don't have access to billing-related operations. Learn more... Learn more...
delete_payment_method	delete			Deactivate the specified Payment Method. The default Payment Method can not be deleted. To add a new default Payment Method, run the Add a payment method operation. To designate an existing Payment Method as the default method, run the Set a default payment method operation. Learn more... Learn more...
post_make_payment_method_default	exec			Make the specified Payment Method the default method for automatically processing payments. Removes the default status from any other Payment Method. Parent and child accounts In a parent and child account environment, the following apply: - Child account users can't run this operation. These users don't have access to billing-related operations. Learn more... Learn more...

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
page	integer	The page of a collection to return.
page_size	integer	The number of items to return per page.

SELECT examples

get_payment_method

View the details of the specified Payment Method.

Learn more...

Learn more...

SELECT
id,
created,
data,
is_default,
type
FROM linode.account.payment_methods;

get_payment_methods

Returns a paginated list of Payment Methods for this Account.

Learn more...

Learn more...

SELECT
data,
page,
pages,
results
FROM linode.account.payment_methods
WHERE page = '{{ page }}'
AND page_size = '{{ page_size }}';

INSERT examples

post_payment_method

Adds a Payment Method to your Account with the option to set it as the default method.

- Adding a default Payment Method removes the default status from any other Payment Method.

- An Account can have up to 6 active Payment Methods.

- Up to 60 Payment Methods can be added each day.

- Prior to adding a Payment Method, ensure that your billing address information is up-to-date with a valid zip by running the Update your account operation.

- A payment_method_add event is generated when a payment is successfully submitted.

Parent and child accounts

In a parent and child account environment, the following apply:

- Child account users can't run this operation. These users don't have access to billing-related operations.

Learn more...

Learn more...

INSERT INTO linode.account.payment_methods (
data__data,
data__is_default,
data__type
)
SELECT 
'{{ data }}' --required,
{{ is_default }} --required,
'{{ type }}' --required
;

Manifest

# Description fields are for documentation purposes
- name: payment_methods
  props:
    - name: data
      value: object
      description: >
        An object representing the credit card information you have on file with Linode to make Payments against your Account.
        
    - name: is_default
      value: boolean
      description: >
        Whether this Payment Method is the default method for automatically processing service charges.
        
    - name: type
      value: string
      description: >
        The type of Payment Method.

Alternative Payment Methods including Google Pay and PayPal can be added using the Cloud Manager. See the [Manage Payment Methods](https://www.linode.com/docs/products/platform/billing/guides/payment-methods/) guide
for details and instructions.
        
      valid_values: ['credit_card']

DELETE examples

delete_payment_method

Deactivate the specified Payment Method.

The default Payment Method can not be deleted. To add a new default Payment Method, run the Add a payment method operation. To designate an existing Payment Method as the default method, run the Set a default payment method operation.

Learn more...

Learn more...

DELETE FROM linode.account.payment_methods;

Lifecycle Methods

post_make_payment_method_default

Make the specified Payment Method the default method for automatically processing payments. Removes the default status from any other Payment Method.

Parent and child accounts

In a parent and child account environment, the following apply:

- Child account users can't run this operation. These users don't have access to billing-related operations.

Learn more...

Learn more...

EXEC linode.account.payment_methods.post_make_payment_method_default 
;