the top-level organisation that uses Elevate to bill its own customers. A Billing Client is the outermost data-isolation boundary in the API. Every other resource (contract owner, site, customer, product, price, invoice, CDR) belongs to exactly one Billing Client, and no request can return data from more than one
Elevate Admin API (1.48)
Currently provides read-only access to list admin entities required by other endpoints. Maintenance of these entities is available via the Elevate frontend or by contacting the Elevate support team.
Billing Client - the top-level organisation that uses Elevate to bill its own customers. A Billing Client is the outermost data-isolation boundary in the API. Every other resource (contract owner, site, customer, product, price, invoice, CDR) belongs to exactly one Billing Client, and no request can return data from more than one.
Contract Owner - the party with which a Customer is contracted to purchase products and services - segregates Customers for reporting and/or branding purposes.
Billing Cycle - means of segregating a Contract Owner's Customer base into separate billing processes which have different start days.
Supplier - the third party supplier of the product or service - allows for a number of different accounts with each supplier.
Invoice Document Profile - defines the configuration used to generate invoices for Customers. This is used on creation of Sites only.
Admin Contact - a configurable contact usable across the entire platform that can receive tripwire, usage cap, and auto-close notifications.
Email Template - a named template of text and substituted values that is used to send emails from the system.
Invoice Marketing Information - for a given sub-brand and invoice template, the marketing information used to populate the invoice template slots. This might be blank, text, images or rich text.
Download OpenAPI description
Languages
Servers
https://rest.elevatebilling.com/v1
- https://rest.elevatebilling.com/v1/billing-client
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://rest.elevatebilling.com/v1/billing-client \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Billing client found
Billing client name
Example: "Imperatives"
Which Online Billing implementation the billing client uses.
- UNAVAILABLE = Online Billing is not available to the billing client
- CLASSIC = the billing client uses the legacy View My Bill implementation
- MODERN = the billing client uses the current View My Bill implementation
Default "UNAVAILABLE"
Enum"UNAVAILABLE""CLASSIC""MODERN"
Example: "UNAVAILABLE"
Response
application/json
{ "id": 1, "name": "Imperatives", "onlineBillingType": "UNAVAILABLE" }