Retrieve Payment Plans Summary

Overview

Fetch the totals shown at the top of the payment plans page: what plans collected this year, how many plans are active, what active plans will charge in the next 4 weeks, and what failed installments of paused plans require review. The totals cover all of the business's plans and do not take any list filters.

Amounts are in the business currency, and payments and plans in any other currency are not included in them. Plan counts include every currency. Only the plans the requesting staff member can see in the payment plans list are counted.

Available for Staff tokens.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json