deposit_paid_bills_details
Creates, updates, deletes, gets or lists a deposit_paid_bills_details resource.
Overview​
| Name | deposit_paid_bills_details |
| Type | Resource |
| Id | ovh.me.deposit_paid_bills_details |
Fields​
The following fields are returned by SELECT queries:
- get
- list
successful operation
| Name | Datatype | Description |
|---|---|---|
bill_detail_id | string | (wire: billDetailId) |
description | string | |
domain | string | |
period_end | string (date) | (wire: periodEnd) |
period_start | string (date) | (wire: periodStart) |
quantity | string | |
total_price | object | Price with its currency and textual representation (wire: totalPrice) |
unit_price | object | LongPrice with all digits and its currency and a textual representation (wire: unitPrice) |
Information about a Bill entry
| Name | Datatype | Description |
|---|---|---|
bill_detail_id | string | (wire: billDetailId) |
description | string | |
domain | string | |
period_end | string (date) | (wire: periodEnd) |
period_start | string (date) | (wire: periodStart) |
quantity | string | |
total_price | object | Price with its currency and textual representation (wire: totalPrice) |
unit_price | object | LongPrice with all digits and its currency and a textual representation (wire: unitPrice) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | bill_detail_id, bill_id, deposit_id | Get this object properties | |
list | select | bill_id, deposit_id | x_pagination_mode | Give access to all entries of the bill |
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"}}) |
bill_detail_id | string | (wire: billDetailId) |
bill_id | string | (wire: billId) |
deposit_id | string | (wire: depositId) |
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
- list
Get this object properties
SELECT
bill_detail_id,
description,
domain,
period_end,
period_start,
quantity,
total_price,
unit_price
FROM ovh.me.deposit_paid_bills_details
WHERE bill_detail_id = '{{ bill_detail_id }}' -- required
AND bill_id = '{{ bill_id }}' -- required
AND deposit_id = '{{ deposit_id }}' -- required
;
Give access to all entries of the bill
SELECT
bill_detail_id,
description,
domain,
period_end,
period_start,
quantity,
total_price,
unit_price
FROM ovh.me.deposit_paid_bills_details
WHERE bill_id = '{{ bill_id }}' -- required
AND deposit_id = '{{ deposit_id }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;