logo

Retrieve a list of invoice timeline messages

Retrieve a list of invoice timeline messages.

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

The resource identifier string.

query Parameters
limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

filter
string

The collection items filter requires a special format. Use "," for multiple allowed values. Use ";" for multiple fields. See the filter guide for more options and examples about this format.

sort
Array of strings

The collection items sort field and order (prefix with "-" for descending sort).

q
string

The partial search of the text fields.

Responses
200

A list of invoice timeline messages was retrieved successfully.

Response Headers
Pagination-Total
integer

Total items count.

Example: 332
Pagination-Limit
integer

Items per page limit.

Example: 100
Pagination-Offset
integer

Pagination offset.

Example: 2
Response Schema: application/json
Array
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 of objects (TimelineTable) >= 0 items
object

Timeline comment author data.

object
Array of objects
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.

get/invoices/{id}/timeline
Request samples
// all parameters are optional except for the `id`
const firstCollection = await api.invoices
    .getAllTimelineMessages({id: 'my-invoice'});

// alternatively you can specify one or more of them
const params = {id: 'my-invoice', limit: 20, offset: 100};
const secondCollection = await api.invoices.getAllTimelineMessages(params);

// access the collection items, each item is a Member
secondCollection.items
    .forEach(message => console.log(message.fields.eventType));
Response samples
application/json
[
  • {
    }
]
➔ Next to Create an invoice Timeline comment