Skip to main content
GET
Get customer retention activities

Headers

X-API-Key
string

Query Parameters

api_key
string

API Key (Deprecated - Use Header X-API-Key instead)

contractId
integer<int64>

Return only the records of this subscription contract.

eventSource
enum<string>

The flow the customer was in: CANCELLATION or PAUSE.

Available options:
PAUSE,
CANCELLATION
status
string

The subscription contract's current status, for example active, paused or cancelled.

retentionAction
string

One action code, sent as a string: 0 none, 1 discount, 2 swap, 3 gift, 4 skip, 5 change date, 6 change address, 7 update frequency, 8 pause, 9 free gift.

retentionReason
string

The reason the customer picked (additionalInfo.actionOption) or the note they typed (additionalInfo.cancellationFeedback), word for word.

fromDay
string<date-time>

Optional. Return only records written at or after this ISO-8601 date-time, such as 2026-11-01T00:00:00Z. Leave it out for no start limit.

toDay
string<date-time>

Optional. Return only records written at or before this ISO-8601 date-time, such as 2026-11-30T23:59:59Z. Leave it out for no end limit.

page
integer
default:0

Zero-based page index (0..N)

Required range: x >= 0
size
integer
default:20

The size of the page to be returned

Required range: x >= 1

Response

Customer retention activities successfully retrieved

activityOn
string

When the record was written, as YYYY-MM-DD HH:MM:SS.S in UTC.

additionalInfo
string

A JSON string, so parse it. actionOption is the reason the customer picked and cancellationFeedback is their note (- or null when they wrote none); both are missing when the customer picked no reason. It can also hold reasonId, offerTier (PRIMARY or FALLBACK), pauseDurationCycle and skipDurationCycle, discountCode and discountType for action 1, and freeGiftVariantId and freeGiftTitle for action 9. Accept keys you don't recognize.

cancellationReason
string

The note the customer typed. null or empty when they wrote none.

contractId
integer<int64>

The subscription contract this record belongs to.

customerEmail
string

The customer's email address on the subscription contract.

customerName
string

The customer's name on the subscription contract.

discountApplied
string

The title of the discount Appstle applied when the customer accepted a discount offer (action 1), such as cancel123456789012. null for every other action.

eventSource
enum<string>

The flow the customer was in, not what they did. A pause the customer accepts in the cancel flow is CANCELLATION with action 8.

Available options:
PAUSE,
CANCELLATION
id
integer<int64>

The record's ID. The list is sorted by it, highest (newest) first.

retentionAction
string

A numeric action code sent as a string: 0 none, 1 discount, 2 swap, 3 gift, 4 skip, 5 change date, 6 change address, 7 update frequency, 8 pause, 9 free gift. Accept codes you don't recognize.

shop
string

The store's myshopify.com domain.

status
string

The subscription contract's current status, for example active, paused or cancelled. It is not a status of the record.