API Preferences¶
Overview¶
API Preferences let an organization choose a preferred rate plan for each API. The saved choice applies to all subscriptions of that API within the selected organization.
Open Monetization → Preferences → API in the API Manager sidebar.
Page description: View an API and select your preferred rate plan.
Why This Matters¶
- Standardizes which rate plan applies when your organization subscribes to an API.
- Avoids ad-hoc plan selection across multiple subscription deals for the same API.
- Complements marketplace self-service and provider-managed subscriptions.
Scope¶
- Organization-scoped preferred plan per API.
- Rate plan preview (pricing modal) before selection.
Outcome¶
- A saved preferred plan for each API in your organization.
- New and existing subscriptions for that API use the selected plan context within the org.
Prerequisites¶
Required Access and Permissions¶
- API Manager access.
- Permission to manage monetization preferences for your organization.
- At least one API with attached rate plans.
Features¶
- Organization selector — choose which organization the preference applies to.
- Search — filter APIs by name.
- Sidebar list — select an API to configure.
- Rate plan table — view plans with transaction limits, View pricing, and Select / Selected actions.
- Save footer — appears when selection differs from the saved preference.
Understanding the Interface¶
Info
Select a preferred rate plan for each API. Your saved choice applies to all subscriptions of that API within the selected organization.
| Area | Content |
|---|---|
| Left sidebar | Searchable list of APIs (name and description) |
| Right panel | Selected API name; Available Rate cards for this API table |
Rate plan table¶
| Column | Action |
|---|---|
| Rate Plan Name | Plan identifier |
| Transaction limit | e.g. 100 / month or Unlimited |
| View | Opens pricing details modal |
| Action | Select or Selected (highlighted when saved) |
Pricing modal fields¶
Plan Name, Transactions, Transaction limit, Initialization Fee, Fixed Per Unit, Initialization Charge, Fixed Recurring, and slab pricing when applicable.
Step-by-Step: Set Preferred Rate Plan¶
Step 1: Open API preferences¶
- Go to Monetization → Preferences → API.
Step 2: Select organization¶
- Choose Organization from the dropdown.
Step 3: Select an API¶
- Search or scroll the sidebar list and click an API.
Step 4: Review and select a plan¶
- Click View to inspect pricing details.
- Click Select on the desired rate plan.
Step 5: Save¶
- When the footer appears (The Selected plan will be applied to all subscriptions of this API.), click Save.
- Success: Preferred rate plan saved successfully.
Empty States¶
| Condition | Message |
|---|---|
| No APIs | No APIs available. |
| No APIs for org | No APIs available for this organization. |
| Search no match | No results match your search. |
| No rate plans | No rate plans available. |