v1

latestOpenAPI 3.1.02026-07-26232644.9 KB
Installments

Retrieve all installments transactions of the period. Fetches ALL installments (past, current, and future) for purchases made within the specified period. Requires API key for authentication and active subscription.

get/tools/api/get-installments

Query parameters

startDatestring date

Start date for filtering (YYYY-MM-DD format)

Start date for filtering. Defaults to first day 3 months ago if not provided.

endDatestring date

End date for filtering (YYYY-MM-DD format)

End date for filtering. Defaults to last day of current month if not provided.

Response

Installments data and statistics

successboolean
{"stackTrail":"components:schemas:InstallmentStats","oasType":"schema","type":"unknown"}
{"stackTrail":"components:schemas:InstallmentSummary","oasType":"schema","type":"unknown"}
timestampstring date-time

Example response

{
  "success": true
}