Skip to main content
GET
List recovery actions

Authorizations

Authorization
string
header
required

API key authentication using a Bearer token in the Authorization header. You can find and manage your API keys at https://auth.slickerhq.com/org/api_keys. Example: Authorization: Bearer YOUR_API_KEY

Query Parameters

pageSize
integer<int32>

Number of recovery actions to return per page. Maximum value is 100. Defaults to 100 if not specified or if value is less than 1.

Required range: x <= 100
pageToken
string

Token for retrieving the next page of results. Use the nextPageToken from a previous response and repeat the same filters, ordering, direction, and page size. Pagination does not pin a database snapshot, so actions created or updated between requests may shift later pages.

subscriptionId
string

Filter recovery actions by the subscription ID in your billing system. E.g. the Chargebee subscription ID.

invoiceId
string

Filter recovery actions by the invoice ID in your billing system. E.g. the Chargebee invoice ID.

customerId
string

Filter recovery actions by the customer ID in your billing system. E.g. the Chargebee customer ID.

cardCountry
string

Filter recovery actions by card country. Must be a valid ISO 3166 alpha-2 country code (e.g., US, IN, GB).

Pattern: ^[A-Z]{2}$
currency
string

Filter recovery actions by currency. Must be a valid ISO 4217 currency code (e.g., USD, EUR, GBP).

status
enum<string>

Filter recovery actions by status. If omitted, pending, succeeded, and failed actions are returned. Scheduled actions must be requested explicitly and represent a provisional snapshot that may change.

Available options:
RECOVERY_ACTION_STATUS_PENDING,
RECOVERY_ACTION_STATUS_SUCCEEDED,
RECOVERY_ACTION_STATUS_FAILED,
RECOVERY_ACTION_STATUS_SCHEDULED
executedAfter
string

Filter recovery actions at or after this date and time (inclusive). For RECOVERY_ACTION_STATUS_SCHEDULED, this applies to scheduledAt; for all other statuses, it applies to executedAt. Use ISO 8601 format with UTC timezone. Example - 2024-01-15T10:30:00Z

executedBefore
string

Filter recovery actions at or before this date and time (inclusive). For RECOVERY_ACTION_STATUS_SCHEDULED, this applies to scheduledAt; for all other statuses, it applies to executedAt. Use ISO 8601 format with UTC timezone. Example - 2024-01-31T23:59:59Z

orderBy
enum<string>

Field to sort results by. Valid options are "executed_at", "scheduled_at", "created_at", or "updated_at". Scheduled queries default to "scheduled_at"; all other queries default to "executed_at".

Available options:
executed_at,
scheduled_at,
created_at,
updated_at
orderDirection
enum<string>

Sort order direction. Must be either "asc" for ascending or "desc" for descending. Scheduled queries default to "asc"; all other queries default to "desc".

Available options:
asc,
desc

Response

A successful response.

recoveryActions
object[]
nextPageToken
string
Example:

"50"

totalSize
integer<int32>
Example:

150