FabriXAPI User Guide

# API Subscription Plan Configuration

As an API Provider, you can edit your API details anytime on Provider Admin Portal. For more information, please refer to “Edit API as Providers”.

# What Can Be Configured for an API Subscription Plan?

# Plan Details

  1. Enable Plan

    • This option would affect your plan's visibility in the API Portal.
    • When the plan is enabled, people will be able to subscribe to your plan.
    • When a plan is disabled, the plan will not appear on the API Portal anymore, so there will be no new subscribers, but existing subscribers can continue to use the plan.

  2. Pricing Model

    • We only support Subscription as pricing for now

  3. Period

    • You can set the auto-renewal period as “Per month” for each plan.

# Features

  1. No. of API Calls

    • It is the quota of API calls a developer can call when they subscribe to your plan.

    • Different Portal plans will support different maximum number of calls/ each API subscription plan, please see below for details:

      1. Starter Portal: 100000
      2. Essential Portal: 500000
      3. Professional Portal: 1000000
      4. Business Portal: 5000000
      5. Enterprise Portal: Customized

  2. Limit Type

    1. There are 2 limit types - Hard Limit & Soft Limit.

      • Hard Limit blocks the developer from making calls when the developer reaches the quota of the plan.
      • Soft limit allows developers to make number of calls more than the specified quota while incurring Overage fees for the extra calls.

    2. For more information, please refer to API Plan Limit Overview.

# Prices

TIP

If you have chosen Stripe as your payment collection approach, you are required to enable monetization before setting any non-free plans (i.e. plans with Price or Overage > 0).

  1. Subscription Price

    • You have the flexibility to set either a standard price or a custom price for your API.

    • Before enabling the custom pricing setting, it is required to provide a Business Support Email on the Provider Profile page. Visit Where to Update API Provider Profile? for more information.

    • Depending on your chosen payment collection approach, currency options vary. With the Standard Flow, you have more currency choices available. However, if you opt for Bring Your Own Stripe or Stripe Connect, only USD is supported.

  2. Overage Price (Only available for Soft Limit)

    • It is the fee for each extra call after subscribers reach the quota of the plan.

# What Will Happen After Updating an API Subscription Plan?

  • Updating an API Subscription Plan will not affect the developers with active subscriptions.

    • Active subscribers have the option to either opt-in for renewing their subscription with the new plan or choose to continue with their original subscription plan without taking any further actions.

  • For more details, please refer to Renew Subscription When API Plan is Updated.

← Use of Public Pricing Plan →