Get consumption
Get details for a consumption.
PATH:
/v1/clients/{clientId}/consumptions/{consumptionId}
PATH PARAMETERS:
clientId required
|
integer
Your assigned |
consumptionId required
|
string
Id of the consumption. |
RESPONSES:
RESPONSE SCHEMA:
id |
string
Id of the retrieved consumption. |
||||||||||||||||||||||||||||||||||||||||||||||||
customerNumber |
string
Id of the customer the consumption is assigned to. |
||||||||||||||||||||||||||||||||||||||||||||||||
subscriptionId |
string
Id of the subscription the consumption is assigned to. |
||||||||||||||||||||||||||||||||||||||||||||||||
invoiceId |
string
Id of the invoice if the consumption has been invoiced. |
||||||||||||||||||||||||||||||||||||||||||||||||
array of items
The items that make up this consumption. |
|||||||||||||||||||||||||||||||||||||||||||||||||
Array () [
] |
|||||||||||||||||||||||||||||||||||||||||||||||||
createdAt |
string date-time
When this consumption was created. |
||||||||||||||||||||||||||||||||||||||||||||||||
billingDate |
string date
The billing date of this consumption. |
||||||||||||||||||||||||||||||||||||||||||||||||
array of refunds
The refunds created on this consumption. |
|||||||||||||||||||||||||||||||||||||||||||||||||
Array () [
] |
|||||||||||||||||||||||||||||||||||||||||||||||||
consumptionTotal object
The totals of the consumption. |
|||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||
refundTotal object
The totals of the refund(s). |
|||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||
array of metadata
Optional. A list of key-value pairs. |
|||||||||||||||||||||||||||||||||||||||||||||||||
Array () [
] |
|||||||||||||||||||||||||||||||||||||||||||||||||
array of _links
List of hypermedia links related to this resource. |
|||||||||||||||||||||||||||||||||||||||||||||||||
Array () [
] |
RESPONSE SCHEMA:
undefinedRESPONSE SCHEMA:
type |
string
The type of error that is carried within this response. The value of this type is an URI that can be dereferenced for a human-readable explanation of the error type. |
category |
string Enum: BUSINESS_ERROR TECHNICAL_ERROR
Category of the error, used primarily to determine whether the same request should be retried or not. Possible values:
|
title |
string
A short, human-readable summary of the problem. |
message |
string
A short, human-readable summary of the problem. Identical to |
RESPONSE SCHEMA:
type |
string
The type of error that is carried within this response. The value of this type is an URI that can be dereferenced for a human-readable explanation of the error type. |
category |
string Enum: BUSINESS_ERROR TECHNICAL_ERROR
Category of the error, used primarily to determine whether the same request should be retried or not. Possible values:
|
title |
string
A short, human-readable summary of the problem. |
message |
string
A short, human-readable summary of the problem. Identical to |
RESPONSE SCHEMA:
type |
string
The type of error that is carried within this response. The value of this type is an URI that can be dereferenced for a human-readable explanation of the error type. |
category |
string Enum: BUSINESS_ERROR TECHNICAL_ERROR
Category of the error, used primarily to determine whether the same request should be retried or not. Possible values:
|
title |
string
A short, human-readable summary of the problem. |
message |
string
A short, human-readable summary of the problem. Identical to |
Path
/v1/clients/{clientId}/consumptions/{consumptionId}
Response samples
200400401404500- {
- "id": "string",
- "customerNumber": "string",
- "subscriptionId": "string",
- "invoiceId": "string",
- "items": [ ... ],
- "createdAt": "string",
- "billingDate": "string",
- "refunds": [ ... ],
- "consumptionTotal": { ... },
- "refundTotal": { ... },
- "metadata": [ ... ],
- "_links": [ ... ]
- {
- "type": "string",
- "category": "string",
- "title": "string",
- "message": "string"
- {
- "type": "string",
- "category": "string",
- "title": "string",
- "message": "string"
- {
- "type": "string",
- "category": "string",
- "title": "string",
- "message": "string"