Documentation IndexFetch the complete documentation index at: /llms.txtUse this file to discover all available pages before exploring further.
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
/v1/billing/recurring/create
/v1/recurring/:scheduleId/pause
/v1/recurring/:scheduleId/resume
/v1/recurring
/v1/recurring/:scheduleId
{ "customerId": "string", "paymentID": "string", "amount": 9.99, "currency": "string", "frequency": "daily | weekly | monthly | yearly", "interval": 1, "startDate": "2024-01-01T00:00:00Z", "endDate": "2024-12-31T23:59:59Z", "maxBillings": 12, "description": "string", "metadata": {} }
customerId
paymentID
amount
currency
frequency
interval
startDate
endDate
maxBillings
description
metadata
{ "statusCode": 201, "success": true, "message": "Recurring schedule created successfully", "data": { "scheduleId": "string", "customerId": "string", "amount": 9.99, "frequency": "monthly", "status": "active", "nextBillingDate": "2024-02-01T00:00:00Z" } }
{ "reason": "string" }
{ "statusCode": 200, "success": true, "message": "Recurring schedule paused successfully", "data": { "scheduleId": "string", "status": "paused", "pausedAt": "2024-01-01T00:00:00Z" } }
{ "statusCode": 200, "success": true, "message": "Recurring schedule resumed successfully", "data": { "scheduleId": "string", "status": "active", "resumedAt": "2024-01-01T00:00:00Z", "nextBillingDate": "2024-02-01T00:00:00Z" } }
status
limit
skip
{ "statusCode": 200, "success": true, "data": { "schedules": [ { "scheduleId": "string", "customerId": "string", "amount": 9.99, "currency": "string", "frequency": "monthly", "status": "active", "nextBillingDate": "2024-02-01T00:00:00Z", "totalBillings": 5, "createdAt": "2024-01-01T00:00:00Z" } ], "total": 1 } }
scheduleId
nextBillingDate
totalBillings
failedAttempts
createdAt
active
paused
cancelled
completed
processing
{ "statusCode": 400, "success": false, "message": "Customer must have approve_recurring permission" }
{ "statusCode": 404, "success": false, "message": "Recurring schedule not found" }