Developer docs
/
Rebilly API
/
Credit memos timeline
/
Retrieve a credit memo timeline message

Retrieve a credit memo timeline message

Retrieves a credit memo timeline 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 credit memo timeline message.

get
/credit-memos/{id}/timeline/{messageId}
Responses

200

Credit memo timeline message retrieved.

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

ID of the timeline message.

type
string

Type of timeline message.

Enum: "credit-memo-created" "credit-memo-applied" "credit-memo-partially-applied" "credit-memo-voided"
triggeredBy
string

Specifies who, or what, triggered the timeline event.

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

Content 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": "credit-memo-created",
"triggeredBy": "rebilly",
"message": "string",
"extraData": {





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

]
}