Sign in
paymentPlans

List payment plans

Use this method to return a paginated 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 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.

get/processing-terminals/{processingTerminalId}/payment-plans

Path parameters

processingTerminalIdstring required

Unique identifier that we assigned to the terminal.

Query parameters

beforestring

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.

afterstring

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.

limitinteger

Limit the maximum number of results that we return for each page.

Headers

Authorizationstring required

Bearer authentication

Response

Successful request. Returns a paginated list of payment plans.

limitinteger required

Maximum number of results that we return for each page.

countinteger required

Number of results we returned on this page.

Note: This might not be the total number of results that match your query.

hasMoreboolean required

Indicates whether there is another page of results available.

Changes

No recorded changes to this endpoint across all 1 revision of this API.