/
Retrieve an invoice timel...

Retrieve an invoice timeline message

Request

Retrieves an invoice timeline message with a specified ID.

Security
SecretApiKey or JWT
Path
idstring, <= 50 characters^[@~\-\.\w]+$required

ID of the resource.

messageIdstringrequired

ID of the invoice timeline message.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/invoices/{id}/timeline/{messageId}' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Invoice message retrieved.

Bodyapplication/json
idstring, <= 50 charactersread-only

ID of the timeline message.

Example:"tmln_0YV8Q9WEF5DTA8HFXS27D1G6GC"
typestringread-only

Type of timeline message.

Enum:"coupon-applied""email-message-sent""invoice-abandoned""invoice-disputed""invoice-issued""invoice-paid""invoice-partially-paid""invoice-partially-refunded""invoice-past-due""invoice-refunded"
triggeredBystringread-only

Specifies who, or what, triggered the timeline event.

Enum:"rebilly""app""direct-api"
messagestring

Describes the message details.

extraDataobject(TimelineExtraData)read-only

Additional data.

occurredTimestring, (date-time)(ServerTimestamp)read-only

Date and time when the timeline message occurred.

Response
{
  "id": "tmln_0YV8Q9WEF5DTA8HFXS27D1G6GC",
  "type": "coupon-applied",
  "triggeredBy": "rebilly",
  "message": "string",
  "extraData": {
    "actions": [ … ],
    "tables": [ … ],
    "author": { … },
    "mentions": { … },
    "links": [ … ]
  },
  "occurredTime": "2019-08-24T14:15:22Z",
  "_links": [
    { … }
  ]
}