For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
    • About Our APIs
  • REST
    • Overview
      • Overview
      • Storefront
      • Management
        • Overview
          • Addresses
          • Authentication
          • Channels
          • Company
          • Invoice Management
          • Orders
          • Payment
            • GETList Payment Methods
            • GETList Company Payment Methods
            • PUTUpdate Company Payment Methods
            • GETList Active Payment Methods
            • GETGet Company Credit Status
            • PUTUpdate Company Credit Status
            • GETGet Company-Level Payment Terms
            • PUTUpdate Company-Level Payment Terms
          • Quotes
          • Sales Staff
          • Shopping List
          • Super Admin
          • Users
  • GraphQL
    • Overview
  • MCP
    • Overview
Dev Portal
LogoLogo
RESTB2BManagementPayment

Get Company Credit Status

GET
https://api-b2b.bigcommerce.com/api/v3/io/companies/:companyId/credit
GET
/api/v3/io/companies/:companyId/credit
$curl https://api-b2b.bigcommerce.com/api/v3/io/companies/1/credit \
>     -H "X-Auth-Token: <apiKey>" \
>     -H "Content-Type: application/json"
1{
2  "code": 200,
3  "data": {
4    "creditEnabled": true,
5    "creditCurrency": "USD",
6    "availableCredit": 5000,
7    "limitPurchases": false,
8    "creditHold": false
9  },
10  "meta": {
11    "message": "Success"
12  }
13}
Returns the credit settings for the Company specified by `companyId`. If the Company credit feature is disabled, this request will fail. See [B2B Edition Settings](https://support.bigcommerce.com/s/article/B2B-Edition-Settings) for more information.
Was this page helpful?
Previous

List Active Payment Methods

Next

Update Company Credit Status

Built with

Returns the credit settings for the Company specified by companyId. If the Company credit feature is disabled, this request will fail. See B2B Edition Settings for more information.

Authentication

X-Auth-Tokenstring
HeaderArgumentDescription
X-Auth-Tokenaccess_tokenFor more about API accounts that generate access_tokens, see our Guide to API Accounts.

For example requests and more information about authenticating BigCommerce APIs, see Authentication and Example Requests.

For more about BigCommerce OAuth scopes, see our Guide to API Accounts.

For a list of API status codes, see API Status Codes.

X-Store-Hashstring
HeaderArgumentDescription
X-Store-Hashstore_hashThe unique store hash associated with a BigCommerce store that has B2B Edition enabled.

Path parameters

companyIdintegerRequired
The unique numeric ID of the Company assigned by B2B Edition.

Response

SUCCESS
codeintegerDefaults to 200
Operation status code.
dataobject
metaobject

Errors

400
Bad Request Error