history_repayment_consumptions

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

Overview

Name	history_repayment_consumptions
Type	Resource
Id	ovh.telephony.history_repayment_consumptions

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
billing_number	string	the number of the bill (wire: billingNumber)
date	string (date)	date of the bill
price	object	the amout which is repayed
status	string	status of the bill (doing, done, error, todo)

list

Previous repayment bill

Name	Datatype	Description
billing_number	string	the number of the bill (wire: billingNumber)
date	string (date)	date of the bill
price	object	the amout which is repayed
status	string	status of the bill (doing, done, error, todo)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	billing_account, date		Get a repayment bill
list	select	billing_account	x_pagination_mode	List repayment bills
create	insert	billing_account		Request a repayment

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"}})
billing_account	string	The name of your billingAccount (wire: billingAccount)
date	string (date)	date of the bill
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 a repayment bill

SELECT
billing_number,
date,
price,
status
FROM ovh.telephony.history_repayment_consumptions
WHERE billing_account = '{{ billing_account }}' -- required
AND date = '{{ date }}' -- required
;

list

List repayment bills

SELECT
billing_number,
date,
price,
status
FROM ovh.telephony.history_repayment_consumptions
WHERE billing_account = '{{ billing_account }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Request a repayment

INSERT INTO ovh.telephony.history_repayment_consumptions (
billing_number,
billing_account
)
SELECT 
'{{ billing_number }}',
'{{ billing_account }}'
RETURNING
billing_number,
date,
price,
status
;

Manifest

# Description fields are for documentation purposes
- name: history_repayment_consumptions
props:
  - name: billing_account
    value: "{{ billing_account }}"
    description: Required parameter for the history_repayment_consumptions resource.
  - name: billing_number
    value: "{{ billing_number }}"
    description: |
      The number of the bill