telephony_security_deposits

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

Overview

Name	telephony_security_deposits
Type	Resource
Id	ovh.order.telephony_security_deposits

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	amount, billing_account		Get prices and contracts information
create	insert	billing_account, amount		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
amount	integer	The amount, in euros, to credit to the current security deposit
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"}})
billing_account	string	The name of your billingAccount (wire: billingAccount)

SELECT examples

get

Get prices and contracts information

SELECT
order_id,
contracts,
details,
prices,
url
FROM ovh.order.telephony_security_deposits
WHERE amount = '{{ amount }}' -- required
AND billing_account = '{{ billing_account }}' -- required
;

INSERT examples

create

Create order

INSERT INTO ovh.order.telephony_security_deposits (
amount,
billing_account
)
SELECT 
{{ amount }} /* required */,
'{{ billing_account }}'
RETURNING
order_id,
contracts,
details,
prices,
url
;

Manifest

# Description fields are for documentation purposes
- name: telephony_security_deposits
props:
  - name: billing_account
    value: "{{ billing_account }}"
    description: Required parameter for the telephony_security_deposits resource.
  - name: amount
    value: {{ amount }}
    description: |
      Available amounts for security deposit crediting
    valid_values: ['10', '20', '30', '40', '50', '100', '200', '300', '400', '500', '1000', '2000', '3000', '4000', '5000', '10000']