Query Pay Plans

Return a paginated list of matching pay plans.

SecurityMarketplace API Key | Merchant Secret Token | Admin JWT | Marketplace JWT | Merchant JWT
Request
query Parameters
limit
integer <int32>

Maximum results per page. Default to 20, must be between 1 and 500.

page
integer <int32>

Page number of results to show (starting at page 1).

sort
string

Comma-delimited list of fields to sort by with sort priority from first to last. Fields are sorted by their natural ordering unless prefixed with a - character.

customerId
Array of strings

Filter by customer identifier

merchantId
Array of strings

Filter by merchant identifier

payPlanState
Array of strings (PayPlanState)

Filter by pay plan state

Items Enum: "Created" "Active" "Completed" "InDefault"
payPlanVariant
Array of strings (PayPlanVariant)

Filter by pay plan variant

Items Enum: "payplan_fortnight_25_25_25_25" "payplan_4_weekly_payments" "payplan_8_weekly_payments" "payplan_26_fortnightly_payments" "payplan_52_weekly_payments" "payplan_2_monthly_payments" "payplan_3_monthly_payments" "payplan_4_monthly_payments" "payplan_5_monthly_payments" "payplan_6_monthly_payments" "payplan_7_monthly_payments" "payplan_8_monthly_payments" "payplan_9_monthly_payments" "payplan_10_monthly_payments" "payplan_11_monthly_payments" "payplan_12_monthly_payments" "payplan_fortnight_0_100" "payplan_4_week_0_100" "payplan_7_week_0_100" "payplan_30_days_0_100"
Responses
200

Matching items sorted as specified

400
401
403
404
405
406
409
422
429
500
503
get/payplans
Request samples
Response samples
application/json
[
  • {
    }
]
Copyright © April Solutions 2023. All right reserved.