Get Company Credit Status

GET

https://api-b2b.bigcommerce.com/api/v3/io/companies/:companyId/credit

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

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, 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

Header	Argument	Description
`X-Store-Hash`	`store_hash`	The 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

codeintegerOptionalDefaults to 200

Operation status code.

dataobjectOptional

metaobjectOptional

Errors

400

Bad Request Error