Account Groups

The account_group object

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

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".
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.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Used by

POSTCreate Account GroupAccount GroupsPATCHUpdate Account GroupAccount GroupsGETList Account GroupsAccount GroupsGETRetrieve Account GroupAccount GroupsDELETEDelete Account GroupAccount GroupsPOSTCreate CustomerCustomersPATCHUpdate CustomerCustomersGETList CustomersCustomersGETRetrieve CustomerCustomersPOSTMerge CustomersCustomersPOSTCreate Sales OrderSales OrdersGETList Sales OrdersSales Orders