payments

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

Overview

Name	payments
Type	Resource
Id	linode.account.payments

Fields

The following fields are returned by SELECT queries:

get_payment

A Payment object.

Name	Datatype	Description
id	integer	Read-only The unique ID of the Payment.
date	string (date-time)	Read-only When the Payment was made. (example: 2018-01-15T00:01:01)
usd	integer	Read-only The amount, in US dollars, of the Payment. (example: 120.50)

get_payments

Returns a paginated list of Payment 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	select			Returns information about a specific Payment. Learn more... Learn more...
get_payments	select		page, page_size	Returns a paginated list of Payments made on this Account. Learn more... Learn more...
post_credit_card	insert	data__card_number, data__expiry_month, data__expiry_year, data__cvv		Deprecated Please run Add a payment method. Adds a credit card Payment Method to your account and sets it as the default method. OAuth scopes. <br /> account:read_write<br /> Learn more...
post_payment	exec			Makes a Payment to your Account. - The requested amount is charged to the default Payment Method if no payment_method_id is specified. - A payment_submitted 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...
post_pay_pal_payment	exec	cancel_url, redirect_url, usd		Deprecated This operation is disabled and no longer accessible. PayPal can be designated as a Payment Method for automated payments using the Cloud Manager. See Manage Payment Methods. OAuth scopes. <br /> account:read_write<br /> Learn more...
post_execute_pay_pal_payment	exec	payer_id, payment_id		Deprecated This operation is disabled and no longer accessible. PayPal can be designated as a Payment Method for automated payments using the Cloud Manager. See Manage Payment Methods. OAuth scopes. <br /> account:read_write<br /> 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

Returns information about a specific Payment.

Learn more...

Learn more...

SELECT
id,
date,
usd
FROM linode.account.payments;

get_payments

Returns a paginated list of Payments made on this Account.

Learn more...

Learn more...

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

INSERT examples

post_credit_card

Deprecated Please run Add a payment method.

Adds a credit card Payment Method to your account and sets it as the default method. OAuth scopes.

<br /> account:read_write<br />

Learn more...

INSERT INTO linode.account.payments (
data__card_number,
data__cvv,
data__expiry_month,
data__expiry_year
)
SELECT 
'{{ card_number }}' --required,
'{{ cvv }}' --required,
{{ expiry_month }} --required,
{{ expiry_year }} --required
;

Manifest

# Description fields are for documentation purposes
- name: payments
  props:
    - name: card_number
      value: string
      description: >
        Your credit card number. No spaces or hyphens (`-`) allowed.
        
    - name: cvv
      value: string
      description: >
        CVV (Card Verification Value) of the credit card, typically found on the back of the card.
        
    - name: expiry_month
      value: integer
      description: >
        A value from 1-12 representing the expiration month of your credit card.

  - 1 = January
  - 2 = February
  - 3 = March
  - Etc.
        
    - name: expiry_year
      value: integer
      description: >
        A four-digit integer representing the expiration year of your credit card.

The combination of `expiry_month` and `expiry_year` must result in a month/year combination of the current month or in the future. An expiration date set in the past is invalid.
        

Lifecycle Methods

post_payment

Makes a Payment to your Account.

- The requested amount is charged to the default Payment Method if no payment_method_id is specified.

- A payment_submitted 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...

EXEC linode.account.payments.post_payment 
@@json=
'{
"payment_method_id": {{ payment_method_id }}, 
"usd": "{{ usd }}"
}';

post_pay_pal_payment

Deprecated This operation is disabled and no longer accessible. PayPal can be designated as a Payment Method for automated payments using the Cloud Manager. See Manage Payment Methods. OAuth scopes.

<br /> account:read_write<br />

Learn more...

EXEC linode.account.payments.post_pay_pal_payment 
@@json=
'{
"cancel_url": "{{ cancel_url }}", 
"redirect_url": "{{ redirect_url }}", 
"usd": "{{ usd }}"
}';

post_execute_pay_pal_payment

Deprecated This operation is disabled and no longer accessible. PayPal can be designated as a Payment Method for automated payments using the Cloud Manager. See Manage Payment Methods. OAuth scopes.

<br /> account:read_write<br />

Learn more...

EXEC linode.account.payments.post_execute_pay_pal_payment 
@@json=
'{
"payer_id": "{{ payer_id }}", 
"payment_id": "{{ payment_id }}"
}';