FabriXAPI User Guide

# API Plan Limit Overview

This article will show you more about API plan limit.

# What is API Plan Limit?

  • API plan limit is the number of calls you can make in your API plan, you can check it on API Portal and Developer Admin Portal

    • API Portal (API Details > Pricing tab)

    • Developer Admin Portal (API Subscriptions > Invoice)

# When will number of API calls used be reflected on Portal?

  • For API User:

    • The number of API calls you used will be reflected on your Developer Admin Portal on API Subscriptions > Invoice page in 15 minutes

  • For API Provider:

    • The number of API calls used by your subscriber will be reflected on your Provider Admin Portal on Subscriptions > Invoice page in 15 minutes
    • The number of total API calls used by your subscriber of a specific API in 30 days will be reflected on your Provider Admin Portal on My API > API Details page daily (updated at 00:00 UTC+8)
      • Note that the total API calls of a specific API also counts the "OPTION" call triggered when user made API calls. i.e. When your subscriber made an API call of your API in Try It Out, an "OPTION" call is triggered and a "GET" call is triggered. Therefore, on API Details page, the number of total API calls of this API is 2.

# What is Hard Limit?

  • API plan with hard limit does not allow additional calls.
  • The phrase "No additional call is allowed in this plan" will be displayed in the plan details of a hard limit API plan. (API Portal > API Details > Pricing tab)

# What is Soft Limit?

  • Soft Limit allows additional calls with overage charges.
  • Overage will be displayed on the plan details of a soft limit API plan (API Portal > API Details > Pricing tab)

# What Will Happen If the Number of API Calls are Used Up?

# For Hard Limit

  • When you used up the No. of API Calls(e.g. used 300/300 API calls), you are NOT allowed to make any extra call

# For Soft Limit

  • When you used up the No. of API Calls(e.g. used 300/300 API calls), you can make extra call with overage charges
  • The total subscription fee of the API plan will be the sum of plan price and overage, for example
    • No. of API Calls = 300
    • Plan Price = USD 0
    • Overage = USD 0.1 for each additional call
      • Subscriber used 301/300 API calls, the subscription fee will be = (Plan Price) + [(No. of additional call) * (Overage per each additional call)]
      • i.e. = USD 0 + (301-300) * USD 0.1 = USD 0.1

← Common API Response Codes →