BillingPlatform is an enterprise billing and revenue management platform. The BillingPlatform Core integration lets your application manage the core billing data model — accounts, contacts, products, contracts, subscriptions, invoices, invoice lines, and usage records — on behalf of your users through Frontegg's integration layer. It authenticates with BillingPlatform's REST API 2.0 using an OAuth 2.0 client credentials grant, so there is no user redirect: the gateway exchanges a Client ID and Client Secret directly for an access token against your tenant.
Prerequisites
Prerequisites
- A BillingPlatform account with administrator access
- Permission to create OAuth 2.0 API clients in your BillingPlatform tenant
BillingPlatform issues OAuth 2.0 credentials to an API client that you create in your tenant's setup area. You will also need two values that identify your tenant: the domain (host) and the organization identifier, both taken from your BillingPlatform URL.
Sign in to BillingPlatform and look at your browser's address bar. Your REST API URL has the form https://<domain>/<organization>/rest/2.0. From it, note:
- Domain — the host without the protocol, for example
acme.billingplatform.com(production) oracme-sandbox.billingplatform.com(sandbox). - Organization — the identifier in the URL path, for example
AcmeProdfromhttps://acme.billingplatform.com/AcmeProd/rest/2.0.
In BillingPlatform, open the setup area and locate the OAuth 2.0 client configuration (under the security / integration settings). Create a new OAuth client and associate it with an API user whose role grants access to the objects you plan to use (accounts, invoices, and so on).
BillingPlatform generates a Client ID and Client Secret for the client.
Copy your Client Secret now
Copy your Client Secret now
The Client Secret is typically shown only once, when the client is created. Copy it immediately and store it securely.
Once you have your Client ID, Client Secret, domain, and organization, configure the integration in the Frontegg portal:
- Open the Frontegg portal and navigate to [ENVIRONMENT] → Integrations → BillingPlatform Core.
- Enter the Client ID and Client Secret.
- Enter your BillingPlatform domain — the host only, without
https://(for example,acme.billingplatform.com). - Enter your Organization identifier (for example,
AcmeProd). - If you are connecting a sandbox tenant, enable the Sandbox environment toggle. This is an indicator only — enter the sandbox host directly in the domain field.
- Select the scopes for the objects your integration needs:
| Object | Scopes |
|---|---|
| Accounts | accounts:read, accounts:write |
| Contacts | contacts:read, contacts:write |
| Products | products:read, products:write |
| Contracts | contracts:read, contracts:write |
| Subscriptions | subscriptions:read, subscriptions:write |
| Invoices | invoices:read, invoices:write |
| Invoice lines | invoicelines:read, invoicelines:write |
| Usage | usage:read, usage:write |
| Metadata | metadata:read, metadata:write |
- Click Save.
Keep your credentials secure
Keep your credentials secure
Never share or commit your Client Secret to version control.