Skip to content

Search is only available in production builds. Try building and previewing the site to test it out locally.

CompanyCredit Container

Displays company credit information including credit limit, outstanding balance, and available credit for B2B customers.

Version: 1.0.0

Configuration

The CompanyCredit container provides the following configuration options:

ParameterTypeReq?Description
classNamestringNoAdds custom CSS classes to the container element. Use to override default styles, integrate with existing design systems, or apply conditional styling based on application state.
creditHistoryParamsGetCompanyCreditHistoryParamsNoProvides optional parameters for filtering and paginating credit history data. Use to control date ranges, page size, or apply custom filters when displaying company credit transactions.
showCreditHistorybooleanNoControls whether to display the credit history section. Set to false to hide historical transactions and show only current credit information, useful for simplified views or when history is displayed elsewhere.

Slots

This container does not expose any customizable slots.

Usage

The following example demonstrates how to use the CompanyCredit container:

import { render as provider } from '@dropins/storefront-company-management/render.js';
import { CompanyCredit } from '@dropins/storefront-company-management/containers/CompanyCredit.js';
await provider.render(CompanyCredit, {
creditHistoryParams: creditHistoryParams,
showCreditHistory: true,
})(block);