Publishing a New Product
1
Open the Admin API console
Navigate to
/dashboard/admin/apis. You must hold the platform_owner role to access this page. If you see an access-denied screen, contact your platform operator to have the role assigned.2
Click Add Product
Click the Add Product button in the top-right corner of the catalog grid. A dialog opens with the product creation form.
3
Fill in product details
Complete the following fields in the dialog:
- Name — the display name developers will see in the marketplace
- Description — a concise summary of what the API does and who it is for
- Gateway endpoint — the URL that handles API requests for this product (e.g.
https://gateway.example.com/v1/payments) - Initial status — choose Draft to keep the product hidden while you configure plans; you will activate it in the final step
4
Save the product
Click Save. The product appears in the catalog grid with a Draft badge, confirming it is not yet visible to developers.
5
Add plans
Expand the product card by clicking on it to open the plans accordion. Click Add Plan and configure the plan:
- Billing mode — choose Free, Fixed, or Metered (see billing modes below)
- Price label — a human-readable price string shown to developers (e.g. “Free”, “$49/month”)
- Monthly quota — the maximum number of API calls allowed per calendar month
- Rate limit — the maximum number of API calls allowed per minute
6
Activate the product
On the product card, flip the status toggle from Draft to Active. The product appears in the developer marketplace immediately — no reload or deployment required.
Editing and Retiring Products
To update an existing product’s details, click Edit on its card. The same product form opens, pre-filled with the current values. Save your changes to apply them; updates to name, description, and gateway endpoint take effect immediately. To temporarily hide a product from the marketplace without deleting it, toggle its status back to Draft. The product remains in your catalog and all its plan configuration is preserved — you can reactivate it at any time by toggling it back to Active. To permanently remove a product, click Delete on the card. A confirmation dialog asks you to confirm the action before the product is removed.Billing Modes Explained
When adding or editing a plan, choose the billing mode that matches how you want to charge for API access:- Free — No charge applied. Use this for trial plans, internal integrations, or open-access tiers where you want to track usage without billing developers.
- Fixed — A flat monthly charge regardless of how many API calls the subscriber makes. Suitable for predictable, budget-friendly plans where developers want cost certainty.
- Metered — Charged based on the actual volume of API calls made during the billing period. Requires your gateway to report usage data to the billing system. Use this for consumption-based pricing where heavy users should pay more.