API Reference
Login to SandboxCreate Account

Find Recurring Plan by Plan Code

get
https://api-test.qualpay.com/platform/plan/

Returns a list of recurring plans for a specified plan_code. The search results include active, archived, and deleted plans. Optional query parameters determine the size and sort order of the returned array.

Path Params
string
required

A unique merchant-generated code used to identify a plan.

Query Params
int32
1 to 100
Defaults to 10

The number of records displayed in the result.

string
Defaults to plan_code

The field that should be used to sort the results. Refer to the response model for available fields.

string
Defaults to asc

How the system should use the order_on value to sort the result. Specify asc (ascending sort order) or desc (descending sort order).

int32

Zero-based page number. When there are more results than the count parameter, use this to select the page to display.

filter
array of strings

Results can be filtered by custom criteria. Refer to Filters to use the filter parameter.

filter
int64

Identifies the merchant to whom this request applies. Optional field, applicable only if the request is sent on behalf of another merchant.
Conditional Requirement: Required if this request is on behalf of another merchant.

Responses

Updated 6 months ago

Language
Credentials
Basic
base64
:
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 6 months ago