List partner plans

List the plans available to the authenticated partner. Usage-based partners get their partner-managed usage plans (editable); plan-based partners get the admin-managed plans assigned to them (read-only).

Auth: Partner. Authentication group, no extra route-level route guard. getPartnerPlanList resolves the partner via getAuthPartner (403 if none). 403 (Partner billing model is not configured.) unless billing_model is usage-based or plan-based. Scoped to plans linked via company_plans (non-deleted): usage-based, then plan_type=usage-based AND is_admin_managed=0; plan-based, then plan_type=plan-based AND is_admin_managed=1.

Rate limit: No rate limit.

Request — no path/query/body params.

Response (data.data array + data.meta) — each plan also returns features + planReviewSites.reviewSite.

  • Plan: id, plan_name, price, original_price, status, plan_type, tier_slug, enforcement_mode, is_admin_managed, description, plan_end_date, short_info, …
  • features[]{ feature_name, enabled, service_limit, limit_type, included_units, overage_rate, hard_stop, partner_billing_enabled }
  • plan_review_sites[]{ review_site_id, pull_frequency, pull_interval, pull_times[], pull_days, review_site:{…} }
  • meta{ billing_model, read_only } (read_only=true for plan-based)
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Response

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json