Account Groups

The account_group object

A named grouping of customer accounts, used for pricing rules or to categorize accounts.

A customer carries at most one group of type type_group as its customer type, plus any number of groups of type pricing_group. Membership of either kind can scope a volume discount to the customer and open up product lines for it to order from.

idstring

Account group ID.

objectstringenumValues:account_group

Resource type identifier.

typestringenumValues:pricing_grouptype_group

How this account group is used.

pricing_group: used for pricing rules, such as a "Preferred" group that receives a special discount.
type_group: used to categorize accounts, such as "Consumers" or "Distributors".

A group's type is fixed when it is created and cannot be changed afterwards.

namestring

Display name of the account group.

Unique within the account.

descriptionstringnullable

Free-form description of the account group.

commission_policystringenumValues:commission_appliedcommission_exempt

How sales commission applies to accounts in this group.

commission_applied: sales commission is calculated on orders from accounts in this group.
commission_exempt: orders from accounts in this group are exempt from commission.

freight_policystringenumValues:free_freightbilled_freight

How freight charges apply to orders from accounts in this group.

free_freight: customers within this group will not have to pay for freight.
billed_freight: freight will be applied to any order within this account group, unless overridden elsewhere.

default_lead_time_daysintegernullable

Calendar days between an order being issued and it being due to ship, inherited by every customer in this group that has neither set its own nor inherited one from a parent account.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Used by

POSTCreate Account GroupAccount Groups PATCHUpdate Account GroupAccount Groups GETList Account GroupsAccount Groups GETRetrieve Account GroupAccount Groups DELETEDelete Account GroupAccount Groups POSTCreate Account PriceAccount Prices PATCHUpdate Account PriceAccount Prices GETList Account PricesAccount Prices GETRetrieve Account PriceAccount Prices POSTCreate CustomerCustomers PATCHUpdate CustomerCustomers GETList CustomersCustomers GETRetrieve CustomerCustomers GETRetrieve Customer Lead TimeCustomers POSTMerge CustomersCustomers POSTCreate Volume DiscountVolume Discounts PATCHUpdate Volume DiscountVolume Discounts GETList Volume DiscountsVolume Discounts GETRetrieve Volume DiscountVolume Discounts POSTCreate Sales OrderSales Orders PATCHUpdate Sales OrderSales Orders GETList Sales OrdersSales Orders GETRetrieve Sales OrderSales Orders PUTClose Sales OrderSales Orders PUTIssue Sales OrderSales Orders PUTReopen Sales OrderSales Orders PUTUnissue Sales OrderSales Orders

account_group example

{
  "id": "acgp_6p4z57e9alaf",
  "object": "account_group",
  "type": "type_group",
  "name": "Wholesale Customers",
  "description": null,
  "commission_policy": "commission_applied",
  "freight_policy": "billed_freight",
  "default_lead_time_days": null,
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "acgp_6p4z57e9alaf",
  "object": "account_group",
  "type": "type_group",
  "name": "Wholesale Customers",
  "description": null,
  "commission_policy": "commission_applied",
  "freight_policy": "billed_freight",
  "default_lead_time_days": null,
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Account Groups

Attributes

Used by