Skip to main content
GET
/
v1
/
recovery_actions
List available recovery actions
curl --request GET \
  --url https://api.slickerhq.com/ingest/v1/recovery_actions \
  --header 'Authorization: Bearer <token>'
{
  "recoveryActions": [
    {
      "requestId": "req_2uqkAo1bwllmzrgV2qtGv48DtGI",
      "invoiceId": "inv_12345678",
      "subscriptionId": "sub_12345678",
      "transactionId": "txn_87654321",
      "actionSuggestion": "ACTION_SUGGESTION_RETRY",
      "idealRetryTime": "2023-01-18T09:30:00Z",
      "createdAt": "2023-01-15T14:20:00Z"
    },
    {
      "requestId": "req_3vrlBp2cwmmn0sH3qruHw59EuHJ",
      "invoiceId": "inv_87654321",
      "subscriptionId": "sub_87654321",
      "transactionId": "txn_12345678",
      "actionSuggestion": "ACTION_SUGGESTION_CARD_CHANGE",
      "idealRetryTime": "2023-01-21T15:45:00Z",
      "createdAt": "2023-01-20T10:30:00Z"
    }
  ],
  "nextPageToken": "123",
  "totalSize": 150
}

Authorizations

​
Authorization
string
header
required

API key authentication using a Bearer token in the Authorization header. Example: Authorization: Bearer YOUR_API_KEY

Query Parameters

​
pageSize
integer<int32>
default:20

Number of recovery actions to return per page (maximum 100)

Required range: 1 <= x <= 100
​
pageToken
string

Token for retrieving the next page of results

​
subscriptionId
string

Filter recovery actions by subscription identifier

​
invoiceId
string

Filter recovery actions by invoice identifier

​
transactionId
string

Filter recovery actions by transaction identifier

​
orderBy
enum<string>
default:RECOVERY_ACTION_ORDER_BY_IDEAL_RETRY_TIME

Field to order the results by

Available options:
RECOVERY_ACTION_ORDER_BY_CREATED_AT,
RECOVERY_ACTION_ORDER_BY_IDEAL_RETRY_TIME
​
orderDirection
enum<string>
default:RECOVERY_ACTION_ORDER_DIRECTION_ASC

Direction to order the results

Available options:
RECOVERY_ACTION_ORDER_DIRECTION_ASC,
RECOVERY_ACTION_ORDER_DIRECTION_DESC

Response

A successful response with list of recovery actions.

Response containing a list of recommended recovery actions with pagination support

​
recoveryActions
object[]

List of recovery actions recommended by Slicker's optimization algorithms

​
nextPageToken
string

Token for retrieving the next page of results. Empty if no more results.

Example:

"123"

​
totalSize
integer<int32>

Total number of recovery actions available across all pages

Example:

150