riverty logo

Docs

Get Subscription Timeline

Get a subscription time - a list of events that has occured on the subscription.

Path

GET /v1/clients/{clientId}/subscriptions/{subscriptionId}/timeline

Request Parameters

clientId required
integer
Your assigned `ClientId`.
subscriptionId required
string
Id of the subscription to retrieve.

Responses

Successful RequestUnsuccessful Request, Incorrect/Missing Information

Response Example

    
        {
 "timeline": [
  {
   "eventType": "INVOICED",
   "recordedAt": "2022-09-30T13:57:25.637Z",
   "payload": {
    "invoiceNumber": "10080"
   }
  }
 ],
 "_links": [
  {
   "method": "GET",
   "href": "https://api.riverty.io/subscription/v1/clients/1234/subscriptions/subscription-id-1/timeline",
   "rel": "self",
   "target": "API"
  },
  {
   "method": "GET",
   "href": "https://api.riverty.io/subscription/v1/clients/1234/subscriptions/subscription-id-1",
   "rel": "subscription",
   "target": "API"
  }
 ]
}
    

Request Example

    
        null