Skip to main content

service_repayment_consumptions

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

Overview​

Nameservice_repayment_consumptions
TypeResource
Idovh.telephony.service_repayment_consumptions

Fields​

The following fields are returned by SELECT queries:

successful operation

NameDatatypeDescription
consumption_idinteger (wire: consumptionId)
calledstring (phone-number)Called number of the call
callingstring (phone-number)Calling number of the call
creation_datetimestring (date-time)the Datetime of the start of the call (wire: creationDatetime)
dialedstring (phone-number)Phone number
durationintegerDuration of the call
operatorstringCalling number's operator
pricenumberPrice repayed with the call
repayablebooleanIs the call repayable right now

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectbilling_account, consumption_id, service_nameGet a repayable call
listselectbilling_account, service_namecreation_datetime.from, creation_datetime.to, x_pagination_modeList repayable calls

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)
consumption_idinteger (wire: consumptionId)
service_namestring (wire: serviceName)
creation_datetime.fromstring (date-time)Filter the value of creationDatetime property (>=) (wire: creationDatetime.from)
creation_datetime.tostring (date-time)Filter the value of creationDatetime property (<=) (wire: creationDatetime.to)
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 repayable call

SELECT
consumption_id,
called,
calling,
creation_datetime,
dialed,
duration,
operator,
price,
repayable
FROM ovh.telephony.service_repayment_consumptions
WHERE billing_account = '{{ billing_account }}' -- required
AND consumption_id = '{{ consumption_id }}' -- required
AND service_name = '{{ service_name }}' -- required
;