Developer docs
/
Rebilly API
/
Orders timeline
/
Retrieve an order timeline message

Retrieve an order timeline message

Retrieves a order message with a specified ID.

SecurityAPI Key: SecretApiKey or HTTP: JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

ID of the resource.

messageId
required
string

ID of the order timeline message.

get
/subscriptions/{id}/timeline/{messageId}
Request samples
const message = await api.subscriptions
    .getTimelineMessage({id: 'foobar-001', messageId: 'message-202'});
console.log(message.fields.eventType);
Responses

200

Order timeline message retrieved.

Response Schema: application/json
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" "invoice-reissued" "invoice-renewal-payment-declined" "invoice-voided" "order-activated" "order-autopay-changed" "order-billing-address-changed" "order-billing-anchor-changed" "order-canceled" "order-churned" "order-completed" "order-custom-fields-changed" "order-delivery-address-changed" "order-downgraded" "order-items-changed" "order-paid-early" "order-quantity-changed" "order-reactivated" "order-recurring-interval-changed" "order-renewal-time-changed" "order-renewed" "order-risk-metadata-changed" "order-upgraded" "order-voided" "order-abandoned" "subscription-paused" "subscription-pause-created" "subscription-pause-modified" "subscription-pause-revoked" "subscription-resumed" "subscription-trial-end-changed" "timeline-comment-created"
triggeredBy
string

Specifies who, or what, triggered the timeline event.

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

Contents of the timeline message.

object (TimelineExtraData)

Additional data.

occurredTime
string <date-time> (ServerTimestamp)

Read-only timestamp in ISO 8601 date-time format.

Array of objects (SelfLink)

Related links.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

Response samples
application/json
{
"id": "tmln_0YV8Q9WEF5DTA8HFXS27D1G6GC",
"type": "coupon-applied",
"triggeredBy": "rebilly",
"message": "string",
"extraData": {





},
"occurredTime": "2019-08-24T14:15:22Z",
"_links": [

]
}