Retrieve invoice timeline messages

Retrieves a list of invoice timeline messages.

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

ID of the resource.

query Parameters
limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer >= 0

Specifies the starting point within the collection of items to be returned.

filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

sort
Array of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -.

q
string

Use this field to perform a partial search of text fields.

Responses
200

List of invoice timeline messages retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

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

ID of the timeline message.

type
string

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

Specifies who, or what, triggered the timeline event.

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

Describes the message details.

object (TimelineExtraData)

Additional data.

Array of objects (TimelineAction) >= 0 items

Actions available for a timeline message. If no actions are available, this field is empty.

Array of objects (TimelineTable) >= 0 items

Table data that is attached to the timeline message.

object

Author of the timeline message.

object

User mentions, or tags, in a timeline.

Array of objects

Links that are attached to a timeline message.

occurredTime
string <date-time>

Date and time when the timeline message occurred.

Array of objects (SelfLink)

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials 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
[
  • {
    }
]