Unified Billing Overview
GraphQL Account API
Unified Billing allows merchants to buy apps through the BigCommerce App Marketplace and have the charges included on their BigCommerce invoice.
To implement Unified Billing, you need to use the GraphQL API, as well as a partner portal account (opens in a new tab) for reconciling charges with your other systems.
Interested in joining the Unified Billing program?
To indicate your interest in becoming part of this program, please take a few minutes to fill out this Google form (opens in a new tab).
OAuth scopes
The following scopes pertain directly to Unified Partner Billing. For a complete list of generally available account-level OAuth scopes, see the Guide to API Accounts.
| UI Name | Permission | Parameter | Description | Resources |
|---|---|---|---|---|
| Subscriptions | modify | account_subscriptions_cancel | View or cancel account-level subscriptions | GraphQL Account API |
| Subscriptions | read-only | account_subscriptions_read | View account-level subscriptions | GraphQL Account API |
| Checkouts | modify | account_checkouts_create | View or cancel account-level checkouts | GraphQL Account API |
| Checkouts | read-only | account_checkouts_read | View account-level checkouts | GraphQL Account API |
Gathering information
Collect the following values to use later.
| Value | Description |
|---|---|
| Authentication headers | To authenticate API requests, visit the account center (opens in a new tab) and generate a new account-level API account. Note the X-Auth-Token property because you must include it in the request headers. You can't reaccess the credentials from this page, so save them somewhere safe. Use the following list of OAuth scopes to inform the scopes you select for the API account. |
| Partner ID | To retrieve the partner ID, sign in to the staging partner portal (Impartner) (opens in a new tab) and go to your account profile. |
| Partner account UUID | To retrieve your partner account UUID, sign in to the Developer portal (opens in a new tab) and copy the Account UUID from the top nav bar. |
| Application ID | Create your app in the staging developer portal (opens in a new tab) and record your application ID. Make sure to also input your partner information associated with the app, especially the partner ID from the partner portal (Impartner) (opens in a new tab). |
| Merchant account UUID | To retrieve the merchant account UUID, send a request to the Get Store Information endpoint and record the merchant's account_uuid from the response. |
Did you find what you were looking for?