SchemaPaymentsPayment Plans

List payment plans

Use this method to retrieve a paginated list of payment plans for a processing terminal.

Note: If you want to view 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.

Path parameters

processingTerminalIdstringRequired>=4 characters<=50 characters
Unique identifier that we assigned to the terminal.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

beforestringOptional
Points to the resource identifier that you want to receive your results before. Typically, this is the first resource on the previous page.
afterstringOptional
Points to the resource identifier that you want to receive your results after. Typically, this is the last resource on the previous page.
limitintegerOptional<=100Defaults to 10
States the total amount of results the response is limited to.

Response

Successful request. Returns a paginated list of payment plans.
limitdouble
Maximum number of results that we return for each page.
countdouble
Number of results that we returned.
hasMoreboolean
Indicates that further results are available.
datalist of objects
Array of paymentPlan objects.

Errors