Retrieve an Invoice Timeline message

Retrieve a invoice message with specified identifier string.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

messageId
required
string

The Invoice Timeline message ID.

Responses
200

Invoice message was retrieved successfully.

Response Schema: application/json
id
string <= 50 characters

The Timeline message identifier string.

type
string

Timeline message type.

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" … 20 more
triggeredBy
string

Shows who or what triggered the Timeline event.

Enum: "rebilly" "app" "direct-api"
message
string

The message that describes the message details.

object (TimelineExtraData)

Additional data.

Array of objects (TimelineAction) >= 0 items

Actions available to a Timeline message. Can be empty in case no actions are available for a message.

Array (>= 0 items)
action
string
redemptionId
string <= 50 characters

The resource ID. Defaults to UUID v4.

Array of objects (TimelineTable) >= 0 items
Array (>= 0 items)
type
string
title
string

Data table title.

footer
string

Data table footer.

Array of objects

Table data. Each array element represents a table row.

object

Timeline comment author data.

userFullName
string
userId
string
object
property name*
additional property
string
Array of objects
Array
resourceType
string
Enum: "kyc-document" "invoice" "subscription" "transaction" "email-message" "dispute" "coupon" "external"
resourceId
string (ResourceId) <= 50 characters

The resource ID. Defaults to UUID v4.

placeholder
string
externalUrl
string
occurredTime
string <date-time>

Timeline message time.

Array of objects (Self) non-empty

The links related to resource.

Array (non-empty)
href
required
string

The link URL.

rel
required
string

The link type.

Value: "self"
401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

get/invoices/{id}/timeline/{messageId}
Request samples
const message = await api.invoices
    .getTimelineMessage({id: 'foobar-001', messageId: 'message-202'});
console.log(message.fields.eventType);
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "type": "coupon-applied",
  • "triggeredBy": "rebilly",
  • "message": "string",
  • "extraData": {
    },
  • "occurredTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}