Skip to main content
GET
/
api
/
v1
/
credits
/
auto-recharge
Get automatic recharge configuration
curl --request GET \
  --url https://api.example.com/api/v1/credits/auto-recharge \
  --header 'X-API-KEY: <api-key>'
{
  "data": {
    "id": null,
    "customerId": "customer-123",
    "currencyId": "credits",
    "isEnabled": false,
    "thresholdType": "CREDIT_AMOUNT",
    "thresholdValue": 0,
    "targetBalance": 0,
    "maxSpendLimit": null,
    "grantExpirationPeriod": "1_YEAR",
    "createdAt": null,
    "updatedAt": null
  }
}

Authorizations

​
X-API-KEY
string
header
required

Server API Key

Query Parameters

​
customerId
string
required

Filter by customer ID (required)

Required string length: 1 - 255
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_|.@-]*$
​
currencyId
string
required

Filter by currency ID (required)

Required string length: 1 - 255
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$

Response

The automatic recharge configuration object.

Response object

​
data
AutoRechargeSettings · object
required

Automatic recharge configuration for a customer and currency