Get consumption timeline

Get a consumption timeline - a list of events that occurred on the consumption.

PATH:

/v1/clients/{clientId}/consumptions/{consumptionId}/timeline

PATH PARAMETERS:

clientId

required

integer

Your assigned ClientId.

consumptionId

required

string

Id of the consumption.

RESPONSES:

200 OK.

RESPONSE SCHEMA:

timeline

array of timeline

List of events that have occurred on this consumption.

Array () [

eventType

string

Enum: INVOICED REFUNDED ADDED

The type of event which has occurred.

recordedAt

string date-time

Time of when the event was recorded.

]

_links

array of _links

List of hypermedia links related to this resource.

Array () [

method

string

HTTP Method.

href

string

Link to the resource.

rel

string

The relation between the current and target resource.

]

400 Bad request.

RESPONSE SCHEMA:

undefined

401 Missing or invalid "Authorization" header.

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: `BUSINESS_ERROR` - A business error occured. This request should not be retried without modification `TECHNICAL_ERROR` - A temporary, technical error occurred. the request should be retried after a back-off period.
title	string A short, human-readable summary of the problem.
message	string A short, human-readable summary of the problem. Identical to `title`.

403 Lacking permissions.

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: `BUSINESS_ERROR` - A business error occured. This request should not be retried without modification `TECHNICAL_ERROR` - A temporary, technical error occurred. the request should be retried after a back-off period.
title	string A short, human-readable summary of the problem.
message	string A short, human-readable summary of the problem. Identical to `title`.

404 Resource not found.

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: `BUSINESS_ERROR` - A business error occured. This request should not be retried without modification `TECHNICAL_ERROR` - A temporary, technical error occurred. the request should be retried after a back-off period.
title	string A short, human-readable summary of the problem.
message	string A short, human-readable summary of the problem. Identical to `title`.

500 Unexpected internal server error.

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: `BUSINESS_ERROR` - A business error occured. This request should not be retried without modification `TECHNICAL_ERROR` - A temporary, technical error occurred. the request should be retried after a back-off period.
title	string A short, human-readable summary of the problem.
message	string A short, human-readable summary of the problem. Identical to `title`.

Path

get

/v1/clients/{clientId}/consumptions/{consumptionId}/timeline

Response samples

200400401403404500

              {
                  
"timeline": [...{
                              "eventType": "string",
                            
                              "recordedAt": "string",
                            
                              "payload": X
                            
}
],
"_links": [...{
                              "method": "string",
                            
                              "href": "string",
                            
                              "rel": "string",
                            
                              "target": X
                            
}
]
}

undefined

              {
                   "type": "string", 
 "category": "string", 
 "title": "string", 
 "message": "string" 
}
                

            

              {
                   "type": "string", 
 "category": "string", 
 "title": "string", 
 "message": "string" 
}
                

            

              {
                   "type": "string", 
 "category": "string", 
 "title": "string", 
 "message": "string" 
}
                

            

              {
                   "type": "string", 
 "category": "string", 
 "title": "string", 
 "message": "string" 
}
                

            