v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB

organizations

Get organization price plan details

Get the BILL price plan details for an existing organization. The currently signed-in user must have the ADMINISTRATOR user role in the BILL organization to perform this operation.

A BILL price plan for an organization provides a range of information, including monthly subscription fees and the terms and conditions for additional charges in the price plan.

In the response, the planTerms object includes information about charges for price plan features based on a combination of charge tier, quantity, and price. We explain plan terms with an example.

If "tier": 1, "quantity": 5, and "price": 10, the first 5 users will be charged $10 each.
If "tier": 2, "quantity": 10, and "price": 8, the next 10 users will be charged $8 each. At this level, if there is no tier information, all users after tier 1 will be charged $8 each.

get/v3/organizations/{organizationId}/price-plan

Path parameters

organizationIdstring required

BILL-generated ID of the organization. The value begins with 008.

Example:{{organization_id}}

Headers

sessionIdstring nullable

API session ID generated with /v3/login

Example:{{session_id}}

devKeystring nullable

Developer key generated with your BILL developer account

Example:{{developer_key}}

Response

Get organization price plan details response

idstring

BILL-generated ID of the price plan. The value begins with ppl.

namestring

Price plan name

monthlyPricenumber

Price plan monthly subscription fee

allowTrialboolean

Set as true if the price plan allows a trial

priceVariesPerUserboolean

Set as true if the price plan has per-user pricing