Forum Discussion

Jake_N's avatar
Jake_N
Mentor
7 years ago

What is a billable API call?

Hey guys,

I am about to start building a search using an endpoint which consolidates multiple API calls. Nothing external is being accessed and nothing external accesses the endpoint. The only thing that accesses the endpoint is the @overridden Lithium search bar.

Is any call made by the search bar to the endpoint classed as a billable call? Or is a billable call only communication to/from an external source.

The reason for this question is the fact that we don't want to make too many billable API calls with this and future components that we make. So understanding this can help us keep the amount to a minimum.

Cheers,

Jake

  • MoniqueS's avatar
    MoniqueS
    7 years ago

    Hi Jake_N,

    Only those calls made from external system are classed as billable API calls.

    Any API call made within the Lithium Community platform are not billable API calls.

    So in this case, it is not billable.

    Thanks!

9 Replies

Sort By
  • MoniqueS's avatar
    MoniqueS
    Lithium Alumni (Retired)
    7 years ago

    Hi Jake_N,

    Only those calls made from external system are classed as billable API calls.

    Any API call made within the Lithium Community platform are not billable API calls.

    So in this case, it is not billable.

    Thanks!

  • luk's avatar
    luk
    Boss
    7 years ago

    MoniqueS just curious: What are the "consequences" of making "billable calls"?

  • VarunGrazitti's avatar
    VarunGrazitti
    Boss
    7 years ago

    luk - The "consequences" would be an overshoot of your platform cost. e.g. you signed up for 10M BAC (Billable API Calls) at X dollars, so if you go beyond that, the X would go up and you'd be getting that shock once you receive your invoice :)

    In case you plan to use the BAC's, it is better to ask support and get a better engagement plan, customers typically chose a bigger plan of 2M or 4M if they have the BAC's in place, and as per their requirements. 

    I hope this helps.

  • luk's avatar
    luk
    Boss
    7 years ago

    Thanks for the info VarunGrazitti, good to know...its not me/us who will be shocked but clients, so knowing that will hopefully prevent me from doing things that would cause this exact scenario =)!

  • luk's avatar
    luk
    Boss
    7 years ago

    VarunGrazitti Is there a way to see how much of the purchased BAC's are used/still available?

  • MoniqueS's avatar
    MoniqueS
    Lithium Alumni (Retired)
    7 years ago

    luk your Lithium Account Executive or Customer Success Manager will be able to get this information for you.

  • Jake_N's avatar
    Jake_N
    Mentor
    6 years ago

    Hey MoniqueS

    I am curious as this question just popped in to my mind the other day. If the end-users browser is classed as an external system?

    When making an ajax or any kind of GET, PUSH, PUT, POST request via javascript the call is outbound from the end-users computer to the server. The only thing that makes me say that this is not classed as an external system, is because the origin value in the header of the call is the domain name of our community.

    If I need to explain myself more please let me know.

  • PeterS's avatar
    PeterS
    Khoros Staff
    6 years ago

    Hey Jake_N 

    You're correct, since it is originating from the community domain, and more specifically community search bar, it is classified as in internal call. Just because a user is accessing community from an external browser doesn't meet the definition of an external system in this scenario.

  • m4ttyb0y's avatar
    m4ttyb0y
    Adept
    6 years ago

    Hi MoniqueS,

    Is there any documentation for more info on Billable API calls? 

    Thanks,