Skip to content

Rate Plans

Overview

The Rate Plans feature lets you create and manage pricing and usage configurations for monetizing API access on Yappes.

With this feature, you can:

  • Define transaction limits (limited per day or month, or unlimited).
  • Configure optional pricing — initialization fee, fixed recurring fee, and pay-as-you-go transaction fees.
  • Store plans in a global catalog and attach each plan to one API or one API Group.
  • Search, view, edit, attach, detach, and delete plans from a single grid.

Open Monetization → Rate Plans in the API Manager sidebar to manage rate plans.

A rate plan covers two areas:

  1. Transaction limits — limited (per day or month) or unlimited API calls
  2. Optional pricing — initialization fee, fixed recurring fee, and/or pay-as-you-go transaction fees

Why This Matters

  • Consistent pricing models across APIs and API Groups before consumers subscribe.
  • A single catalog for creating plans independently of attachment.
  • Controlled one-to-one linking — each plan attaches to only one API or one API Group at a time.
  • Foundation for marketplace pricing, applications, and manage-subscription workflows.

Scope

  • Rate plan creation, viewing, editing, and deletion.
  • Attach and detach plans to APIs or API Groups from the Rate Plans page.
  • Transaction limits and optional layered pricing configuration.
  • Rate plan grid search and management.

Outcome

  • Organized pricing plans ready to attach to APIs or API Groups.
  • Clear visibility into which API or group each plan is linked to.
  • Predictable attach-and-detach behavior from the Rate Plans grid.

Prerequisites

Required Access and Permissions

Users must have:

  • API Manager access.
  • Permission to manage pricing plans (provider deal / pricing access).

System / Technical Requirements

  • APIs must be onboarded before you attach rate plans to them. For more information, see Onboard APIs.

Features

  • Rate plan grid — list all plans with columns: Rate Plan Name, Attached to, Attach & Detach, View, Edit, Delete.
  • Search — filter plans by name (Search by Plan name).
  • Create Rate Plans — open the create form with a live preview panel.
  • Attached to navigation — click the API or API Group name to open API details or the API Group edit page.
  • Attach / Detach toggle — the Attach & Detach column shows Attach when the plan is unattached (Attached to shows —) and Detach when it is linked to an API or API Group.
Column Description
Rate Plan Name The name of the pricing plan
Attached to The API or API Group the plan is linked to, if any
Attach & Detach Link or unlink the plan from an API or API Group
View Open a read-only detail view
Edit Update plan configuration
Delete Remove the plan from the catalog

How to Create a Rate Plan

The same create form is used wherever you define a rate plan. Open it from any of these entry points:

Entry point Navigation
Rate Plans page Monetization → Rate Plans → Create Rate Plans
API onboarding Rate Plans section → Attach Rate Plan → Create New tab
Manage Subscriptions Create Subscription → Create Custom Rate Plans

During REST or SOAP API onboarding Step 3, use the Rate Plans section. See Onboard APIs Step 3.

Step 1: Set plan name and transaction limits

  • Plan name — e.g. Standard API Plan
  • Unlimited Transactions — turn on for no cap; turn off to set a limit
  • Transaction Limit — e.g. 1000 (required when not unlimited)
  • Transaction period — Day or Month
  • Example: 1000 calls per Month

Step 2: Configure pricing (optional)

  • Turn on Setup pricing for plan to add fees; leave off for usage limits only
  • Currency — INR
  • Billing Period — Monthly (fixed)

When setup pricing is on, enable any combination of:

  • Charge initialisation fee
  • Initialisation Charge — e.g. ₹103

  • Example: consumer pays ₹103 once at subscription start

  • Fixed recurring pricing

  • Frequency (billing periods) — e.g. 2
  • Fixed Recurring Price — e.g. ₹200

  • Example: ₹200 every 2 months

  • Pay as you go pricing — choose one model:

  • Fixed per unit pricing — Fixed per unit price e.g. ₹100
    • Example: 100 transactions × ₹100 = ₹10,000
  • Slab pricing — rows with From Unit, To Unit, and Price; leave To Unit blank for open-ended ranges
    • Example slabs: 0–100 @ ₹20, 100–200 @ ₹15, 200–500 @ ₹10, 500+ @ ₹8
    • Example: 250 transactions = (100 × ₹20) + (100 × ₹15) + (50 × ₹10) = ₹4,000

Step 3: Review the preview

  • Use Rate plan preview on the right
  • Enter API Transaction count (default 100)
  • Review one-time, recurring, and transaction fees and Total First billing period (monthly)

Step 4: Save the plan

  • Click Create Plan (or Save Plan when editing)

Sample rate plan

Plan name: Partner API Plan
Limit: 1,000 transactions / month
Initialisation: ₹103
Recurring: ₹200 every 2 months
Pay as you go: Slab pricing (0–100 @ ₹20, 100–200 @ ₹15, 200+ @ ₹10)
At 250 transactions, preview shows initialization + recurring + slab fees for the first billing period.

Attaching a Rate Plan

Step 1: Open the attach modal

  • In the grid, click Attach in the Attach & Detach column (shown when the plan is not attached — Attached to shows —).

Step 2: Review plan summary

  • Modal title: Attach Rate Plan
  • The summary panel shows plan name, transaction type, limits, pricing fields, and slab rows if applicable.

Step 3: Select attach target

Field Options
Attach To API or API Group (Application is disabled)
Select API / Select Groups Searchable list; APIs show REST/SOAP protocol badge

Placeholders: Select Attach option / Select or search API/groups from list

Step 4: Confirm attach

  • Attach Rate Plan is disabled until both fields are selected.
  • Click Attach Rate Plan to link the plan to the chosen API or API Group.

Note

A rate plan can be attached to only one API or one API Group at a time. Detach it before attaching to a different target.

Success

The plan is linked to the selected API or API Group. The Attached to column updates in the grid.

Detaching a Rate Plan

Step 1: Open the detach modal

  • In the grid, click Detach in the Attach & Detach column (shown when the plan is attached).

Step 2: Review warning and details

  • Modal title: Detach Rate Plan
  • Warning: "Detach will remove the rate plan from the attached API."
  • Attached API Name and the plan summary panel are shown.

Step 3: Confirm detach

  • Click Detach (red).
  • Detach removes the association; the plan remains in the catalog.

Success

The plan is detached. Attached to shows — and the column action changes back to Attach.

Viewing and Editing a Rate Plan

View

  • Click View (eye icon) in the grid.
  • The modal shows the plan name, Unlimited Transactions or Limited Transactions badge, pricing details, and slab pricing if configured.
  • Click Edit to switch to edit mode. On the Rate Plans page, the view modal shows Edit only — use the grid Detach action to unlink a plan.

Edit

  • Click Edit (pencil icon) in the grid, or Edit from the view modal.
  • The same form as create opens with pre-filled values. Modal title: Create Rate Plan.
  • Save Plan is shown instead of Create Plan.

Edit constraints:

Condition Behavior
No fields changed Error: "No changes detected — Please update at least one field before saving."
Plan name empty "Plan name required"

For full field reference, see How to Create a Rate Plan.

Success

The plan is updated and the grid refreshes with your changes.

Deleting a Rate Plan

Step 1: Open delete confirmation

  • Click Delete (trash icon) in the grid.

Step 2: Review warning (if attached)

  • If attached, warning: "Deleting this Rate Plan will detach it from the attached APIs"
  • Attached API Name is shown.

Step 3: Confirm delete

  • Click Delete (red).
  • The plan is removed from the catalog.

Success

The rate plan is deleted and removed from the grid.

Best Practices

Practice Reason
Create plans in the catalog first, then attach Keeps pricing defined before linking to an API or group
Attach before marketplace listing Consumers only see plans linked to the API
Detach before reassigning One plan, one target at a time
Review the preview when creating Validates fees before saving
Use View before Edit or Delete Confirms current limits and pricing

Troubleshooting

Issue Possible Cause Resolution
Attach Rate Plan disabled Attach To or target not selected Complete both dropdown fields
Application unavailable in Attach To Not supported in current UI Use API or API Group
Cannot attach to second API Plan already attached Detach first, then attach to new target
Save rejected with no changes Form matches saved record Change at least one field
Delete warning appears Plan is still attached Confirm detach-on-delete or detach manually first
Empty grid No plans created yet Click Create Rate Plans
Plan not visible in marketplace Not attached to the API Attach the plan from this page or API onboarding