email_pro_accounts

Creates, updates, deletes, gets or lists an email_pro_accounts resource.

Overview

Name	email_pro_accounts
Type	Resource
Id	ovh.order.email_pro_accounts

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
order_id	integer	Identifier of the order (wire: orderId)
contracts	array	List of contracts related to the order
details	array	Details of the order
prices	object	Prices of the order including with and without taxes
url	string	URL to download the order

list

An order

Name	Datatype	Description
order_id	integer	Identifier of the order (wire: orderId)
contracts	array	List of contracts related to the order
details	array	Details of the order
prices	object	Prices of the order including with and without taxes
url	string	URL to download the order

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	duration, number, service		Get prices and contracts information
list	select	number, service	x_pagination_mode	Get allowed durations for 'account' option
create	insert	duration, service, number		Create order

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"}})
duration	string	Duration
number	integer	Number of Accounts to order
service	string	The internal name of your pro organization
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 prices and contracts information

SELECT
order_id,
contracts,
details,
prices,
url
FROM ovh.order.email_pro_accounts
WHERE duration = '{{ duration }}' -- required
AND number = '{{ number }}' -- required
AND service = '{{ service }}' -- required
;

list

Get allowed durations for 'account' option

SELECT
order_id,
contracts,
details,
prices,
url
FROM ovh.order.email_pro_accounts
WHERE number = '{{ number }}' -- required
AND service = '{{ service }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create order

INSERT INTO ovh.order.email_pro_accounts (
number,
duration,
service
)
SELECT 
{{ number }} /* required */,
'{{ duration }}',
'{{ service }}'
RETURNING
order_id,
contracts,
details,
prices,
url
;

Manifest

# Description fields are for documentation purposes
- name: email_pro_accounts
props:
  - name: duration
    value: "{{ duration }}"
    description: Required parameter for the email_pro_accounts resource.
  - name: service
    value: "{{ service }}"
    description: Required parameter for the email_pro_accounts resource.
  - name: number
    value: {{ number }}
    description: |
      Number of Accounts to order