SchemaPaymentsPayment Plans

List payment plans

Retrieve a list of payment plans.

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