Depending on applicable regulations or business limitations, specific API requests may not be available for your use.

Get All Billing Plans

This request returns a list of the available billing plans for the firm, including advisory, brokerage, and platform plans.

Note: This call only supports updates to Institutional firms. Attempts to update corporate firms will receive an UNSUPPORTED error along with the firmId specified.

Request URL

Syntax GET /restapi/firms/{firmId}/billingplans
Example URL https://testapi.foliofn.com/restapi/firms/TESTFIRMID/billingplans

Response Data Fields

Field Description
advisoryBilling The list of available advisory billing plan IDs.
brokerageBillingDisclosed Boolean indicator of whether the advisory billing plan is disclosed or wrapped.
If "false", the advisory billing plan is wrapped and is grossed up to include the brokerage billing plan.
If "true", the detail of the brokerage billing plan can be returned separately by calling Get a Billing Plan for the provided brokerageBilling ID.
brokerageBilling

The available brokerage billing plan ID. When brokerageBillingDisclosed is true, this field will be returned.

Note: There is only one brokerage billing plan per firm.

platformBilling

The available platform billing plan ID.

Note: There is only one platform billing plan per firm.

Response Example


HTTP/1.1 200 OK
X-Powered-By: Servlet/2.5
Server: Sun GlassFish Enterprise Server v2.1.1
Location: https://testapi.foliofn.com/restapi/firms/TESTFIRMID/billingplans
Link: <https://testapi.foliofn.com/restapi/firms/TESTFIRMID/billingplans>; rel="GET"; type="application/json"; title="getBillingPlans"
Content-Type: application/json
Transfer-Encoding: chunked
Date: Fri, 21 Feb 2014 18:23:54 GMT

{
  "brokerageBilling" : "11111111111111111111",
  "platformBilling" : "2222222222222222222",
  "brokerageBillingDisclosed" : true,
  "advisoryBilling" : [
    "3333333333333333333",
    "44444444444444444444"
  ]
}

Getting Started

REST APIs

Resources

Developer Home