API Reference
  1. Benji Pays Partner API
  2. Plans

List plans for authenticated distributor

get
https://api.benjipays.com/v2/plans

Access: Requires DISTRIBUTOR actor type

Returns a paginated list of plans visible to the authenticated distributor. Plans can be filtered by status and partnerId (for custom-priced plans).

Visibility:

  • Distributors see plans with their distributorExternalId
  • Can optionally filter by partnerId for partner-specific custom pricing

Requires JWT authentication and 'partners:plans:read' scope.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
length ≤ 255

Optional filter for Partner-specific custom-priced plans

string
enum

Optional filter by plan status

Allowed:
integer
1 to 100

Number of results per page (default: 20, max: 100)

integer
0 to 9007199254740991

Number of results to skip for pagination (default: 0)

Headers
uuid

Optional client-supplied unique ID for one request. The server generates a UUID v4 if omitted and always echoes the value in the response.

uuid

Optional ID that flows across service boundaries for distributed tracing. The server generates a UUID v4 if omitted and always echoes the value in the response.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 1 month ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated about 1 month ago

Did this page help you?