Skip to main content
POST
Receive payment retry instructions from Slicker

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"