Sign in

v1

latestOpenAPI 3.1.02026-07-2616459400.5 KB
Subaccount API

Set Recurring Credits

Configure automatic recurring credit allocation for a subaccount.

post/subaccounts/setrecurringcreditddetails

Headers

api_keystring required
Example:x-api-key-123456789

Add your master account API key.

Request body

usernamestring required

Add subaccount to receive recurring credits.

recurring_creditinteger required

Add the number of credits added each cycle.

timeperiodstring required

Choose how often credits should be added — daily, weekly, or monthly.

start_datestring

Add the start date for recurring credits in YYYY-MM-DD format.

end_datestring

Add the end date to stop recurring credits in YYYY-MM-DD format.

statusstring

Set recurring credit status — use enable to activate or disable to stop.

Example request

{
  "username": "acme_marketing_team",
  "recurring_credit": 10000,
  "timeperiod": "monthly",
  "start_date": "2026-03-01",
  "end_date": "2026-12-31",
  "status": "enable"
}

Response

Recurring credit rule saved