GET
/
recovery_actions
curl --request GET \
  --url https://api.slickerhq.com/v1/recovery_actions \
  --header 'Authorization: Bearer <token>'
{
  "recoveryActions": [
    {
      "id": "ract_1NvzFX2eZvKYlo2CaVKfbuKN",
      "subscriptionId": "sub_1NvzFX2eZvKYlo2CaVKfbuKN",
      "invoiceId": "in_1NvzFX2eZvKYlo2CaVKfbuKN",
      "customerId": "cus_1NvzFX2eZvKYlo2CaVKfbuKN",
      "transactionId": "txn_1NvzFX2eZvKYlo2CaVKfbuKN",
      "paymentMethodType": "card",
      "cardCountry": "US",
      "currency": "USD",
      "type": "RECOVERY_ACTION_TYPE_RETRY",
      "status": "RECOVERY_ACTION_STATUS_SUCCEEDED",
      "integrationType": "INTEGRATION_TYPE_STRIPE",
      "createdAt": "2024-01-15T10:30:00Z",
      "executedAt": "2024-01-15T10:35:00Z",
      "updatedAt": "2024-01-15T10:35:00Z"
    }
  ],
  "nextPageToken": "50",
  "totalSize": 150
}

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

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.

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).

currency
string

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

executedAfter
string

Filter recovery actions executed after this date and time (inclusive). Use ISO 8601 format with UTC timezone. Example - 2024-01-15T10:30:00Z

executedBefore
string

Filter recovery actions executed before this date and time (inclusive). 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", "created_at", or "updated_at".

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

Sort order direction. Must be either "asc" for ascending or "desc" for descending. Defaults to "desc".

Available options:
asc,
desc

Response

200
application/json

A successful response.

The response is of type object.