Skip to main content
GET
Get recovery settings

Authorizations

Authorization
string
header
required

Paste your secret key as the bearer token: sk_test_… (test) or sk_live_… (live). That is all a normal API call needs. OAuth access tokens from POST /v1/oauth/token also work, but a client id/secret is only for platforms acting on another tenant's behalf, not for your own integration.

Response

200 - application/json

OK

autoRecovery
boolean
renewalReminders
boolean
renewalReminderDays
integer
abandonedCart
boolean
dunningEnabled
boolean
dunningEscalationDays
integer
dunningEscalation
enum<string>
Available options:
cancel,
pause,
mark_unpaid
paydayAware
boolean
maxAttempts
integer
retryRails
enum<string>[]
Available options:
card,
transfer,
ussd,
virtual_account,
direct_debit,
wallet
retryOffsetsHours
integer[]