payment_mean_deferred_payment_accounts

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

Overview

Name	payment_mean_deferred_payment_accounts
Type	Resource
Id	ovh.me.payment_mean_deferred_payment_accounts

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer
creation_date	string (date-time)	Creation date of this deferred account (wire: creationDate)
default_payment_mean	boolean	This deferred account is the default payment mean? (wire: defaultPaymentMean)
description	string	Custom description of this deferred account
icon	object	Payment method type icon
label	string	Deferred account type
state	string	Deferred account state (failed, valid)

list

Deferred account information

Name	Datatype	Description
id	integer
creation_date	string (date-time)	Creation date of this deferred account (wire: creationDate)
default_payment_mean	boolean	This deferred account is the default payment mean? (wire: defaultPaymentMean)
description	string	Custom description of this deferred account
icon	object	Payment method type icon
label	string	Deferred account type
state	string	Deferred account state (failed, valid)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id		Get this object properties
list	select		x_pagination_mode	List of payment mean deferred accounts
update	update	id		Alter this object properties
choose_as_default_payment_mean	exec	id		Choose this deferred account as your default payment mean. Will cancel the previous choice.

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
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
id	integer	Id
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Get this object properties

SELECT
id,
creation_date,
default_payment_mean,
description,
icon,
label,
state
FROM ovh.me.payment_mean_deferred_payment_accounts
WHERE id = '{{ id }}' -- required
;

list

List of payment mean deferred accounts

SELECT
id,
creation_date,
default_payment_mean,
description,
icon,
label,
state
FROM ovh.me.payment_mean_deferred_payment_accounts
WHERE x_pagination_mode = '{{ x_pagination_mode }}'
;

UPDATE examples

update

Alter this object properties

UPDATE ovh.me.payment_mean_deferred_payment_accounts
SET 
description = '{{ description }}'
WHERE 
id = '{{ id }}' --required;

Lifecycle Methods

EXEC variables use wire (API) names.

choose_as_default_payment_mean

Choose this deferred account as your default payment mean. Will cancel the previous choice.

EXEC ovh.me.payment_mean_deferred_payment_accounts.choose_as_default_payment_mean 
@id='{{ id }}' --required
;