Get automatic recharge configuration

Retrieves the automatic recharge configuration for a customer and currency. Returns default settings if no configuration exists.

GET /api/v1/credits/auto-recharge

JavaScript

JavaScript

import Stigg from '@stigg/typescript';

const client = new Stigg({
  apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted
});

const response = await client.v1.credits.getAutoRecharge({
  currencyId: 'currencyId',
  customerId: 'customerId',
});

console.log(response.data);

200

{
  "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

Headers

X-ACCOUNT-ID · string

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-ID · string

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the 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

200

application/json

The automatic recharge configuration object.

Response object

data · AutoRechargeSettings · object · required

Automatic recharge configuration for a customer and currency

Show child attributes