debt_accounts
Creates, updates, deletes, gets or lists a debt_accounts resource.
Overview​
| Name | debt_accounts |
| Type | Resource |
| Id | ovh.me.debt_accounts |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
active | boolean | |
due_amount | object | Amount of debts the account has (wire: dueAmount) |
pending_amount | object | Amount currently being processed (wire: pendingAmount) |
todo_amount | object | Reserved amount awaiting payment (wire: todoAmount) |
unmatured_amount | object | Unmatured amount for deferred payment term (wire: unmaturedAmount) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | Get this object properties | ||
pay | exec | Create an order in order to pay all your due debts |
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"}}) |
SELECT examples​
- get
Get this object properties
SELECT
active,
due_amount,
pending_amount,
todo_amount,
unmatured_amount
FROM ovh.me.debt_accounts
;
Lifecycle Methods​
EXEC variables use wire (API) names.
- pay
Create an order in order to pay all your due debts
EXEC ovh.me.debt_accounts.pay
;