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

A Payment object.

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

list

Returns a paginated list of payment objects.

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	paymentId		Returns information about a specific Payment. Learn more... Learn more...
list	select		X-Filter, page, page_size	Returns a paginated list of payments made on this Account. Learn more... Learn more...
create	insert	card_number, expiry_month, expiry_year, 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...
make_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...
stage_paypal_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...
execute_paypal_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
paymentId	string	The ID of the Payment to look up.
X-Filter		Specifies a JSON object to filter down the results. See Filtering and sorting for details. (example: {{X-Filter}})
page	integer	The page of a collection to return.
page_size	integer	The number of items to return per page.

SELECT examples

get

Returns information about a specific Payment.

Learn more...

Learn more...

SELECT
id,
date,
usd
FROM linode.account.payments
WHERE paymentId = '{{ paymentId }}' -- required
;

list

Returns a paginated list of payments made on this Account.

Learn more...

Learn more...

SELECT
id,
date,
usd
FROM linode.account.payments
WHERE X-Filter = '{{ X-Filter }}'
AND page = '{{ page }}'
AND page_size = '{{ page_size }}'
;

INSERT examples

create

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 (
card_number,
cvv,
expiry_month,
expiry_year
)
SELECT 
'{{ card_number }}' /* required */,
'{{ cvv }}' /* required */,
{{ expiry_month }} /* required */,
{{ expiry_year }} /* required */
RETURNING
message
;

Manifest

# Description fields are for documentation purposes
- name: payments
props:
  - name: card_number
    value: "{{ card_number }}"
    description: |
      Your credit card number. No spaces or hyphens (`-`) allowed.
  - name: cvv
    value: "{{ cvv }}"
    description: |
      CVV (Card Verification Value) of the credit card, typically found on the back of the card.
  - name: expiry_month
    value: {{ expiry_month }}
    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: {{ expiry_year }}
    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

make_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.make_payment 
@@json=
'{
"payment_method_id": {{ payment_method_id }}, 
"usd": "{{ usd }}"
}'
;

stage_paypal_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.stage_paypal_payment 
@@json=
'{
"cancel_url": "{{ cancel_url }}", 
"redirect_url": "{{ redirect_url }}", 
"usd": "{{ usd }}"
}'
;

execute_paypal_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.execute_paypal_payment 
@@json=
'{
"payer_id": "{{ payer_id }}", 
"payment_id": "{{ payment_id }}"
}'
;