Skip to main content
POST
/
recovery_action
Receive payment retry instructions from Slicker
curl --request POST \
  --url https://api.your-company.com/slicker-webhook/recovery_action \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "requestId": "req_2uqkAo1bwllmzrgV2qtGv48DtGI",
  "invoiceId": "inv_12345678",
  "subscriptionId": "sub_12345678",
  "actionSuggestion": "ACTION_SUGGESTION_RETRY",
  "idealRetryTime": "2023-01-18T09:30:00Z"
}
'
{
  "success": true,
  "message": "Retry scheduled"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
requestId
string
required

Unique identifier for the request from Slicker

Example:

"req_2uqkAo1bwllmzrgV2qtGv48DtGI"

​
invoiceId
string
required

Identifier for the invoice that should be retried

Example:

"inv_12345678"

​
actionSuggestion
enum<string>
required

Suggested action to take for this recovery attempt

Available options:
ACTION_SUGGESTION_UNSPECIFIED,
ACTION_SUGGESTION_RETRY,
ACTION_SUGGESTION_CARD_CHANGE
Example:

"ACTION_SUGGESTION_RETRY"

​
idealRetryTime
string<date-time>
required

The optimal time to execute the retry according to Slicker's algorithms

Example:

"2023-01-18T09:30:00Z"

​
subscriptionId
string

Identifier for the subscription associated with the invoice

Example:

"sub_12345678"

Response

Retry instructions received successfully

​
success
boolean

Indicates if the retry instruction was successfully received

Example:

true

​
message
string

Additional information about the response

Example:

"Retry scheduled"