List payment plans
Use this method to return a [paginated](https://docs.payroc.com/api/pagination) list of payment plans for a processing terminal.
**Note:** If you want to view the details of a specific payment plan and you have its paymentPlanId, use our [Retrieve Payment Plan](https://docs.payroc.com/api/schema/payments/payment-plans/retrieve) method.
Our gateway returns the following information about each payment plan in the list:
- Name, length, and currency of the plan
- How often our gateway collects each payment
- How much our gateway collects for each payment
- What happens if the merchant updates or deletes the plan
For each payment plan, we return the paymentPlanId, which you can use to perform follow-on actions.
Path parameters
processingTerminalId
Unique identifier that we assigned to the terminal.
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Query parameters
before
Return the previous page of results before the value that you specify.
You can’t send the before parameter in the same request as the after parameter.
after
Return the next page of results after the value that you specify.
You can’t send the after parameter in the same request as the before parameter.
limit
Limit the maximum number of results that we return for each page.
Response
Successful request. Returns a paginated list of payment plans.
limit
Maximum number of results that we return for each page.
count
Number of results we returned on this page.
Note: This might not be the total number of results that match your query.
hasMore
Indicates whether there is another page of results available.
data
Array of paymentPlan objects.
links
Reference links to navigate to the previous page of results or to the next page of results.
