Skip to main content

history_tollfree_consumptions

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

Overview​

Namehistory_tollfree_consumptions
TypeResource
Idovh.telephony.history_tollfree_consumptions

Fields​

The following fields are returned by SELECT queries:

successful operation

NameDatatypeDescription
datestring (date)date of the bill
priceobjectthe amount which is paid by the called number
statusstringstatus of the bill (doing, done, error, todo)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectbilling_account, dateGet a toll-free bill
listselectbilling_accountx_pagination_modeList toll-free bills

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.

NameDatatypeDescription
api_hoststringThe 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_accountstringThe name of your billingAccount (wire: billingAccount)
datestring (date)date of the bill
x_pagination_modestringSent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples​

Get a toll-free bill

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