riverty logo

Docs

Get Consumption Timeline

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

Path

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

Request Parameters

clientId required
integer
Your assigned `ClientId`.
consumptionId required
string
Id of the consumption.

Responses

Successful RequestUnsuccessful Request, Incorrect/Missing Information

Response Example

    
        {
 "timeline": [
  {
   "eventType": "INVOICED",
   "recordedAt": "2022-09-30T07:30:08.8272298+00:00",
   "payload": {
    "invoiceNumber": "100079"
   }
  }
 ],
 "_links": [
  {
   "method": "GET",
   "href": "https://api.riverty.io/subscription/v1/clients/1234/consumptions/consumption-id-1",
   "rel": "consumption",
   "target": "API"
  },
  {
   "method": "GET",
   "href": "https://api.riverty.io/subscription/v1/clients/1234/consumptions/consumption-id-1/timeline",
   "rel": "self",
   "target": "API"
  }
 ]
}
    

Request Example

    
        null