Plan-builder context (partner)

Get the authenticated partner's billing model, contract model, billing config, per-feature rates, and review-site universe — everything the Plan Builder UI needs to render.

Auth: Partner. Route is in the authentication group with no extra route-level route guard; The endpoint enforces the role in the controller. partnerPlanBuilderContext calls getAuthPartner, walking the company tree up to the bundle_id=1 partner. 403 if no partner resolves. Any user inside a partner tree (partner/account/location) resolves to and is scoped by their owning partner.

Rate limit: No rate limit.

Request — no path/query/body params.

Response (data.data object + data.meta)

  • partner{ id, name, billing_model, contract_model }
  • config — partner CompanyBillingConfig (location_rate, one_time_fee, …) or null
  • feature_rates[]{ feature_name, rate_per_unit, enabled }
  • review_site_universe[]{ review_site_id, name, color, pull_frequency, pull_interval, pull_times[], pull_days[] }
  • meta.plans_read_onlytrue for plan-based partners, false for usage-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