Customers

The customer object

A business you sell to, with its contact details, default fulfillment settings, and order policies.

idstring

Customer ID.

objectstringenumValues:customer

Resource type identifier.

namestring

The customer's business name, as shown throughout the app and on documents.

numberstring

Human-readable customer number used to identify the account, distinct from the id.

statusstringenumValues:normalpreferredhold_shipment

Account status code, controlling whether the customer can transact.

normal: standard active account with no restrictions.
preferred: active account flagged as preferred.
hold_shipment: orders can be placed, but shipments are held.
hold_all: all activity is on hold.

edi_statusstringenumValues:enableddisabled

Whether EDI (Electronic Data Interchange) is enabled for exchanging orders and documents with this customer.

relationship_typestringenumValues:standaloneparentchild

The customer's position in the account hierarchy.

standalone: no parent or child accounts.
parent: has one or more child accounts (see child_accounts).
child: belongs to a parent account (see parent_account).

commission_policystringenumValues:commission_appliedcommission_exempt

How sales commission applies to this customer's orders.

commission_exempt: this customer's orders are exempt from sales commission.
commission_applied: sales commission is calculated on this customer's orders.

notestringnullable

Free-form note about the customer.

credit_limitquantitynullable

Maximum credit extended to this customer.

idstring

Quantity ID.

objectstringenumValues:quantity

Resource type identifier.

valuestring (decimal)

Raw decimal value of the quantity, as a string to preserve precision.

This is the unformatted machine value; see display_value for the human-readable rendering with unit and thousands separators.

display_valuestring

Formatted value with unit abbreviation (e.g. "$1,234.56" or "100 kg").

unitunitnullable

Unit of measure for this value (e.g. a currency, mass, or count unit).

idstring

Unit ID.

objectstringenumValues:unit

Resource type identifier.

namestring

Display name of the unit (e.g. "Gram", "Kilogram").

abbreviationstring

Short abbreviation for the unit (e.g. "g", "kg").

typestringenumValues:currencyquantitytime

Physical dimension the unit measures, such as mass, volume, or currency.

A unit can only be converted to another unit of the same dimension. The quantity dimension is for discrete countable items rather than a physical measure.

ratio_numeratorstring (decimal)

Conversion ratio numerator relative to the base unit in the same dimension.

ratio_denominatorstring (decimal)

Conversion ratio denominator relative to the base unit in the same dimension.

Cannot be zero.

offset_numeratorstring (decimal)

Conversion offset numerator, used for temperature-like conversions.

Zero for most unit types.

offset_denominatorstring (decimal)

Conversion offset denominator.

Typically 1. Cannot be zero.

is_base_unitboolean

Whether this is the base unit for its dimension.

Conversion ratios are relative to this unit. Base units are platform-defined; account-created units always have this set to false.

ownerownernullable

Owner of this resource.

Always returned as null in this endpoint.

created_atstring (date-time)

When this unit was created.

updated_atstring (date-time)

When this unit was last updated.

contact_infocustomer_contact_infonullable

Contact information.

objectstringenumValues:customer_contact_info

Resource type identifier.

emailstringnullable

Email address.

phonestringnullable

Phone number.

urlstringnullable

Website URL.

freight_preferencescustomer_freight_preferencesnullable

Freight and carrier preferences applied to this customer's shipments.

objectstringenumValues:customer_freight_preferences

Resource type identifier.

statusstringenumValues:free_freightbilled_freight

Freight policy applied to this customer's orders.

free_freight: the customer is not billed for freight.
billed_freight: freight is billed to the customer, unless overridden elsewhere.

carriercarriernullable

Default carrier.

idstring

Carrier ID.

objectstringenumValues:carrier

Resource type identifier.

namestring

Human-readable name for the carrier, unique among your account's carriers.

codestringnullableenumValues:fedexupsusps

Well-known carrier identifier, set only for recognized carriers and absent for custom ones.

fedex, ups, usps: integrated carriers managed through Shippo (live rating and labels).
will_call: customer picks the order up; no carrier shipment.
delivery: delivered by your own vehicles/drivers.
ltl, ltl1: less-than-truckload freight carriers.
freight_collect: freight billed to and arranged by the receiver.

account_numberstringnullable

Your account number with this carrier, used to connect UPS and USPS accounts.

customer_portal_visibilitystringenumValues:visiblehidden

Whether customers can see and select this carrier at checkout in the customer portal.

ownerownernullable

Provenance of this carrier.

System-owned carriers are platform-provided defaults shared across all accounts and cannot be deleted; account-owned carriers are custom to your account.

Always returned as null in this endpoint.

service_levelslistnullable

Shipping service levels offered by this carrier (e.g. ground, overnight).

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

null when the last page has been reached.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

null while on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of service_level

Resources in this page.

idstring

Service level ID.

objectstringenumValues:service_level

Resource type identifier.

namestring

Human-readable name for the service level, shown to customers at checkout when the service level is visible.

service_level_tokenstring

Carrier-specific code identifying this service level (e.g. fedex_ground, ups_next_day_air).

Values are carrier-defined, so any non-empty string is accepted.

customer_portal_visibilitystringenumValues:visiblehidden

Whether customers can see and select this service level at checkout in the customer portal.

is_defaultboolean

Whether this is the carrier's default service level, pre-selected when the carrier is chosen.

Each carrier has at most one default; setting a new default clears the previous one.

ownerownernullable

Provenance of this service level.

System-owned service levels are platform-provided defaults that cannot be updated or deleted; account-owned service levels are custom to your account.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

deleted_atstring (date-time)nullable

Soft-delete timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

service_levelservice_levelnullable

Default service level.

idstring

Service level ID.

objectstringenumValues:service_level

Resource type identifier.

namestring

Human-readable name for the service level, shown to customers at checkout when the service level is visible.

service_level_tokenstring

Carrier-specific code identifying this service level (e.g. fedex_ground, ups_next_day_air).

Values are carrier-defined, so any non-empty string is accepted.

customer_portal_visibilitystringenumValues:visiblehidden

Whether customers can see and select this service level at checkout in the customer portal.

is_defaultboolean

Whether this is the carrier's default service level, pre-selected when the carrier is chosen.

Each carrier has at most one default; setting a new default clears the previous one.

ownerownernullable

Provenance of this service level.

System-owned service levels are platform-provided defaults that cannot be updated or deleted; account-owned service levels are custom to your account.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

billing_typestringnullableenumValues:senderthird_party

Who pays the carrier for shipments.

sender: the shipper (you) pays the carrier.
third_party: a third party is billed, using billing_account.

billing_accountstringnullable

Carrier billing account number charged when billing_type is third_party.

defaultscustomer_defaultsnullable

Default settings applied to new orders for this customer.

objectstringenumValues:customer_defaults

Resource type identifier.

payment_termpayment_termnullable

Default payment term.

idstring

Payment term ID.

objectstringenumValues:payment_term

Resource type identifier.

namestring

Display name (e.g. Net 30).

statusstringenumValues:activeinactive

Lifecycle status of the payment term.

ownerownernullable

Owner of this resource, indicating whether it is an Augno-provided system default or was created by your account.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

shipping_termshipping_termnullable

Default shipping term.

idstring

Shipping term ID.

objectstringenumValues:shipping_term

Resource type identifier.

namestring

Human-readable name for the shipping term, used to identify it when assigning shipping terms to customers and orders.

typestringenumValues:free_freightflat_rate_freightcarrier_rate_freight

Freight pricing model applied by this shipping term.

free_freight: no shipping cost to the buyer.
flat_rate_freight: a fixed shipping cost regardless of order details (see flat_rate).
carrier_rate_freight: shipping cost is determined by the carrier's quoted rate.

ownerownernullable

Provenance of this shipping term.

System-owned shipping terms are platform-provided defaults shared across all accounts and cannot be updated or deleted; account-owned shipping terms are custom to your account.

Always returned as null in this endpoint.

flat_ratequantitynullable

Fixed shipping charge applied to the order.

Applied only when type is flat_rate_freight; ignored for other freight pricing models.

Always returned as null in this endpoint.

minimum_order_valuequantitynullable

Order subtotal a buyer must reach before this term's free-shipping rules apply.

Always returned as null in this endpoint.

free_shipping_service_levelslistnullable

Service levels that ship for free under this term (typically once minimum_order_value is met).

Always returned as null in this endpoint.

created_atstring (date-time)

When this shipping term was created.

updated_atstring (date-time)

When this shipping term was last updated.

priorityprioritynullable

Default priority.

idstring

Priority ID.

objectstringenumValues:priority

Resource type identifier.

codestringenumValues:lownormalhigh

Machine-readable code identifying the priority level.

low: lowest urgency; worked after normal and high.
normal: default urgency for most orders and picks.
high: highest urgency; worked ahead of normal and low.

namestring

Display name of the priority level.

ownerownernullable

Owner of this resource.

Priorities are platform-provided and shared across all accounts, so the owner is always the Augno system owner.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

sales_repaccount_usernullable

Default sales rep.

idstring

Account user ID.

objectstringenumValues:account_user

Resource type identifier.

statusstringenumValues:activedisabledremoved

Account user status.

active: the user can access the account.
disabled: the user is locked out of the account.
removed: the user has been removed (soft-deleted) from the account.

rolerolenullable

Assigned role.

Always returned as null in this endpoint.

departmentdepartmentnullable

Assigned department.

Always returned as null in this endpoint.

userusernullable

Underlying user.

idstring

User ID.

objectstringenumValues:user

Resource type identifier.

emailstringnullable

Email address.

namestringnullable

User's full display name.

usernamestringnullable

Username.

email_verified_atstring (date-time)nullable

When the user verified their email address.

image_urlstringnullable

URL of the user's profile image.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

last_used_atstring (date-time)nullable

When the user last accessed this account.

created_atstring (date-time)

When the account user was created.

updated_atstring (date-time)

When the account user was last updated.

notification_preferencescustomer_notification_preferencesnullable

Notification preferences.

objectstringenumValues:customer_notification_preferences

Resource type identifier.

accepts_invoice_emailsboolean

Whether invoice emails are accepted.

bill_to_addressaddressnullable

Default billing address.

idstring

Address ID.

objectstringenumValues:address

Resource type identifier.

namestring

Display name of the address.

phonestringnullable

Phone number associated with the address.

emailstringnullable

Email address associated with the address.

typestringenumValues:standarddrop_ship

How the address is used.

standard: a normal shipping or billing address.
drop_ship: an address an order is shipped to directly, typically a third party or end customer rather than the account itself.

geolocationgeolocationnullable

Geolocation details for the address.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

ship_to_addressaddressnullable

Default shipping address.

idstring

Address ID.

objectstringenumValues:address

Resource type identifier.

namestring

Display name of the address.

phonestringnullable

Phone number associated with the address.

emailstringnullable

Email address associated with the address.

typestringenumValues:standarddrop_ship

How the address is used.

standard: a normal shipping or billing address.
drop_ship: an address an order is shipped to directly, typically a third party or end customer rather than the account itself.

geolocationgeolocationnullable

Geolocation details for the address.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

typeaccount_groupnullable

The account group of type type_group that categorizes this customer (for example "Distributors").

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.

price_groupslistnullable

Account groups of type pricing_group that this customer belongs to, used to apply pricing rules.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

null when the last page has been reached.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

null while on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of account_group

Resources in this page.

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.

parent_accountcustomernullable

Parent account.

Present if this is a child account.

idstring

Customer ID.

objectstringenumValues:customer

Resource type identifier.

namestring

The customer's business name, as shown throughout the app and on documents.

numberstring

Human-readable customer number used to identify the account, distinct from the id.

statusstringenumValues:normalpreferredhold_shipment

Account status code, controlling whether the customer can transact.

normal: standard active account with no restrictions.
preferred: active account flagged as preferred.
hold_shipment: orders can be placed, but shipments are held.
hold_all: all activity is on hold.

edi_statusstringenumValues:enableddisabled

Whether EDI (Electronic Data Interchange) is enabled for exchanging orders and documents with this customer.

relationship_typestringenumValues:standaloneparentchild

The customer's position in the account hierarchy.

standalone: no parent or child accounts.
parent: has one or more child accounts (see child_accounts).
child: belongs to a parent account (see parent_account).

commission_policystringenumValues:commission_appliedcommission_exempt

How sales commission applies to this customer's orders.

commission_exempt: this customer's orders are exempt from sales commission.
commission_applied: sales commission is calculated on this customer's orders.

notestringnullable

Free-form note about the customer.

credit_limitquantitynullable

Maximum credit extended to this customer.

Always returned as null in this endpoint.

contact_infocustomer_contact_infonullable

Contact information.

Always returned as null in this endpoint.

freight_preferencescustomer_freight_preferencesnullable

Freight and carrier preferences applied to this customer's shipments.

Always returned as null in this endpoint.

defaultscustomer_defaultsnullable

Default settings applied to new orders for this customer.

Always returned as null in this endpoint.

notification_preferencescustomer_notification_preferencesnullable

Notification preferences.

Always returned as null in this endpoint.

bill_to_addressaddressnullable

Default billing address.

Always returned as null in this endpoint.

ship_to_addressaddressnullable

Default shipping address.

Always returned as null in this endpoint.

typeaccount_groupnullable

The account group of type type_group that categorizes this customer (for example "Distributors").

Always returned as null in this endpoint.

price_groupslistnullable

Account groups of type pricing_group that this customer belongs to, used to apply pricing rules.

Always returned as null in this endpoint.

parent_accountcustomernullable

Parent account.

Present if this is a child account.

Always returned as null in this endpoint.

child_accountslistnullable

Child accounts.

Present if this is a parent account.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

child_accountslistnullable

Child accounts.

Present if this is a parent account.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

null when the last page has been reached.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

null while on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of customer

Resources in this page.

idstring

Customer ID.

objectstringenumValues:customer

Resource type identifier.

namestring

The customer's business name, as shown throughout the app and on documents.

numberstring

Human-readable customer number used to identify the account, distinct from the id.

statusstringenumValues:normalpreferredhold_shipment

Account status code, controlling whether the customer can transact.

normal: standard active account with no restrictions.
preferred: active account flagged as preferred.
hold_shipment: orders can be placed, but shipments are held.
hold_all: all activity is on hold.

edi_statusstringenumValues:enableddisabled

Whether EDI (Electronic Data Interchange) is enabled for exchanging orders and documents with this customer.

relationship_typestringenumValues:standaloneparentchild

The customer's position in the account hierarchy.

standalone: no parent or child accounts.
parent: has one or more child accounts (see child_accounts).
child: belongs to a parent account (see parent_account).

commission_policystringenumValues:commission_appliedcommission_exempt

How sales commission applies to this customer's orders.

commission_exempt: this customer's orders are exempt from sales commission.
commission_applied: sales commission is calculated on this customer's orders.

notestringnullable

Free-form note about the customer.

credit_limitquantitynullable

Maximum credit extended to this customer.

Always returned as null in this endpoint.

contact_infocustomer_contact_infonullable

Contact information.

Always returned as null in this endpoint.

freight_preferencescustomer_freight_preferencesnullable

Freight and carrier preferences applied to this customer's shipments.

Always returned as null in this endpoint.

defaultscustomer_defaultsnullable

Default settings applied to new orders for this customer.

Always returned as null in this endpoint.

notification_preferencescustomer_notification_preferencesnullable

Notification preferences.

Always returned as null in this endpoint.

bill_to_addressaddressnullable

Default billing address.

Always returned as null in this endpoint.

ship_to_addressaddressnullable

Default shipping address.

Always returned as null in this endpoint.

typeaccount_groupnullable

The account group of type type_group that categorizes this customer (for example "Distributors").

Always returned as null in this endpoint.

price_groupslistnullable

Account groups of type pricing_group that this customer belongs to, used to apply pricing rules.

Always returned as null in this endpoint.

parent_accountcustomernullable

Parent account.

Present if this is a child account.

Always returned as null in this endpoint.

child_accountslistnullable

Child accounts.

Present if this is a parent account.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Used by

POSTCreate CustomerCustomers PATCHUpdate CustomerCustomers GETList CustomersCustomers GETRetrieve CustomerCustomers DELETEDelete CustomerCustomers POSTMerge CustomersCustomers POSTCreate Sales OrderSales Orders GETList Sales OrdersSales Orders

customer example

{
  "id": "ac_0170df1ac58e4d24c66fc89f5f",
  "object": "customer",
  "name": "Acme Inc.",
  "number": "100042",
  "status": "normal",
  "edi_status": "disabled",
  "relationship_type": "standalone",
  "commission_policy": "commission_applied",
  "note": "Preferred customer since 2020.",
  "credit_limit": {
    "id": "qty_015a85becc1a6afdfb1afc27ff",
    "object": "quantity",
    "value": "1234.56",
    "display_value": "$1,234.56",
    "unit": {
      "id": "un_01966263f74a5a0cae356000a1",
      "object": "unit",
      "name": "US Dollar",
      "abbreviation": "$",
      "type": "currency",
      "ratio_numerator": "1",
      "ratio_denominator": "1",
      "offset_numerator": "0",
      "offset_denominator": "1",
      "is_base_unit": true,
      "owner": {
        "object": "owner",
        "type": "system",
        "account": null
      },
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  },
  "contact_info": {
    "object": "customer_contact_info",
    "email": "orders@acme.com",
    "phone": "555-123-4567",
    "url": "https://acme.com"
  },
  "freight_preferences": {
    "object": "customer_freight_preferences",
    "status": "billed_freight",
    "carrier": {
      "id": "cr_01784fd54c9ba197bb4e42f0e6",
      "object": "carrier",
      "name": "FedEx",
      "code": "fedex",
      "account_number": null,
      "customer_portal_visibility": "visible",
      "owner": {
        "object": "owner",
        "type": "account",
        "account": {
          "id": "ac_01148680966698341a9c0976db",
          "object": "account",
          "name": "Acme Inc.",
          "default_billing_address": null,
          "default_shipping_address": null,
          "branding": null,
          "portal": null,
          "created_at": "2026-05-10T00:00:00Z",
          "updated_at": "2026-05-10T00:23:00Z"
        }
      },
      "service_levels": null,
      "deleted_at": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    },
    "service_level": {
      "id": "crop_01cfaf03f104e90ef9680e2a30",
      "object": "service_level",
      "name": "FedEx Ground",
      "service_level_token": "fedex_ground",
      "customer_portal_visibility": "visible",
      "is_default": false,
      "owner": {
        "object": "owner",
        "type": "account",
        "account": {
          "id": "ac_01148680966698341a9c0976db",
          "object": "account",
          "name": "Acme Inc.",
          "default_billing_address": null,
          "default_shipping_address": null,
          "branding": null,
          "portal": null,
          "created_at": "2026-05-10T00:00:00Z",
          "updated_at": "2026-05-10T00:23:00Z"
        }
      },
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    },
    "billing_type": "sender",
    "billing_account": "123456789"
  },
  "defaults": {
    "object": "customer_defaults",
    "payment_term": {
      "id": "pytm_018694d6601ea771cd1b52e890",
      "object": "payment_term",
      "name": "Net 30",
      "status": "active",
      "owner": {
        "object": "owner",
        "type": "system",
        "account": null
      },
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    },
    "shipping_term": {
      "id": "shtm_014341ab4bb5bf94d5b6936f86",
      "object": "shipping_term",
      "name": "Prepaid",
      "type": "carrier_rate_freight",
      "owner": {
        "object": "owner",
        "type": "system",
        "account": null
      },
      "flat_rate": null,
      "minimum_order_value": null,
      "free_shipping_service_levels": {
        "object": "list",
        "page_info": {
          "next_page_url": null,
          "previous_page_url": null,
          "has_next_page": false,
          "has_prev_page": false
        },
        "data": []
      },
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    },
    "priority": {
      "id": "pi_01fc435701244bb3978bfb77ff",
      "object": "priority",
      "code": "normal",
      "name": "Normal",
      "owner": {
        "object": "owner",
        "type": "system",
        "account": null
      },
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    },
    "sales_rep": {
      "id": "acus_01ea9983ddb41dacc44ecf997c",
      "object": "account_user",
      "status": "active",
      "role": {
        "id": "rl_01c16d2eb637c0d1f3a372937c",
        "object": "role",
        "name": "Admin",
        "type": "admin",
        "owner": {
          "object": "owner",
          "type": "account",
          "account": {
            "id": "ac_01148680966698341a9c0976db",
            "object": "account",
            "name": "Acme Inc.",
            "default_billing_address": null,
            "default_shipping_address": null,
            "branding": null,
            "portal": null,
            "created_at": "2026-05-10T00:00:00Z",
            "updated_at": "2026-05-10T00:23:00Z"
          }
        },
        "permissions": [
          "customers:create",
          "customers:read",
          "customers:update",
          "customers:delete"
        ],
        "created_at": "2026-05-10T00:00:00Z",
        "updated_at": "2026-05-10T00:23:00Z"
      },
      "department": null,
      "user": {
        "id": "us_0151164dcaea4cbded27b50aae",
        "object": "user",
        "email": "jdoe@augno.com",
        "name": "John Doe",
        "username": "jdoe",
        "email_verified_at": "2026-06-10T00:00:00Z",
        "image_url": "https://cdn.augno.com/avatars/us_0151164dcaea4cbded27b50aae.jpg",
        "created_at": "2026-05-10T00:00:00Z",
        "updated_at": "2026-05-10T00:23:00Z"
      },
      "last_used_at": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  },
  "notification_preferences": {
    "object": "customer_notification_preferences",
    "accepts_invoice_emails": true
  },
  "bill_to_address": {
    "id": "ad_012100950cfaa34aa0e0ad7258",
    "object": "address",
    "name": "Headquarters",
    "phone": null,
    "email": null,
    "type": "standard",
    "geolocation": {
      "id": "gl_013e4c26412103c6757ba71806",
      "object": "geolocation",
      "street_line_1": "4200 Industrial Pkwy",
      "street_line_2": null,
      "locality": "Columbus",
      "state": "OH",
      "postal_code": "43204",
      "country": "US"
    },
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "ship_to_address": {
    "id": "ad_012100950cfaa34aa0e0ad7258",
    "object": "address",
    "name": "Headquarters",
    "phone": null,
    "email": null,
    "type": "standard",
    "geolocation": {
      "id": "gl_013e4c26412103c6757ba71806",
      "object": "geolocation",
      "street_line_1": "4200 Industrial Pkwy",
      "street_line_2": null,
      "locality": "Columbus",
      "state": "OH",
      "postal_code": "43204",
      "country": "US"
    },
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "type": {
    "id": "acgp_018e88072d1320808dc979cfac",
    "object": "account_group",
    "type": "type_group",
    "name": "Wholesale Customers",
    "description": null,
    "commission_policy": "commission_applied",
    "freight_policy": "billed_freight",
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "price_groups": {
    "object": "list",
    "page_info": {
      "next_page_url": null,
      "previous_page_url": null,
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "id": "acgp_018e88072d1320808dc979cfac",
        "object": "account_group",
        "type": "type_group",
        "name": "Wholesale Customers",
        "description": null,
        "commission_policy": "commission_applied",
        "freight_policy": "billed_freight",
        "created_at": "2026-05-10T00:00:00Z",
        "updated_at": "2026-05-10T00:23:00Z"
      }
    ]
  },
  "parent_account": null,
  "child_accounts": null,
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "ac_0170df1ac58e4d24c66fc89f5f",
  "object": "customer",
  "name": "Acme Inc.",
  "number": "100042",
  "status": "normal",
  "edi_status": "disabled",
  "relationship_type": "standalone",
  "commission_policy": "commission_applied",
  "note": "Preferred customer since 2020.",
  "credit_limit": {
    "id": "qty_015a85becc1a6afdfb1afc27ff",
    "object": "quantity",
    "value": "1234.56",
    "display_value": "$1,234.56",
    "unit": {
      "id": "un_01966263f74a5a0cae356000a1",
      "object": "unit",
      "name": "US Dollar",
      "abbreviation": "$",
      "type": "currency",
      "ratio_numerator": "1",
      "ratio_denominator": "1",
      "offset_numerator": "0",
      "offset_denominator": "1",
      "is_base_unit": true,
      "owner": {
        "object": "owner",
        "type": "system",
        "account": null
      },
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  },
  "contact_info": {
    "object": "customer_contact_info",
    "email": "orders@acme.com",
    "phone": "555-123-4567",
    "url": "https://acme.com"
  },
  "freight_preferences": {
    "object": "customer_freight_preferences",
    "status": "billed_freight",
    "carrier": {
      "id": "cr_01784fd54c9ba197bb4e42f0e6",
      "object": "carrier",
      "name": "FedEx",
      "code": "fedex",
      "account_number": null,
      "customer_portal_visibility": "visible",
      "owner": {
        "object": "owner",
        "type": "account",
        "account": {
          "id": "ac_01148680966698341a9c0976db",
          "object": "account",
          "name": "Acme Inc.",
          "default_billing_address": null,
          "default_shipping_address": null,
          "branding": null,
          "portal": null,
          "created_at": "2026-05-10T00:00:00Z",
          "updated_at": "2026-05-10T00:23:00Z"
        }
      },
      "service_levels": null,
      "deleted_at": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    },
    "service_level": {
      "id": "crop_01cfaf03f104e90ef9680e2a30",
      "object": "service_level",
      "name": "FedEx Ground",
      "service_level_token": "fedex_ground",
      "customer_portal_visibility": "visible",
      "is_default": false,
      "owner": {
        "object": "owner",
        "type": "account",
        "account": {
          "id": "ac_01148680966698341a9c0976db",
          "object": "account",
          "name": "Acme Inc.",
          "default_billing_address": null,
          "default_shipping_address": null,
          "branding": null,
          "portal": null,
          "created_at": "2026-05-10T00:00:00Z",
          "updated_at": "2026-05-10T00:23:00Z"
        }
      },
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    },
    "billing_type": "sender",
    "billing_account": "123456789"
  },
  "defaults": {
    "object": "customer_defaults",
    "payment_term": {
      "id": "pytm_018694d6601ea771cd1b52e890",
      "object": "payment_term",
      "name": "Net 30",
      "status": "active",
      "owner": {
        "object": "owner",
        "type": "system",
        "account": null
      },
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    },
    "shipping_term": {
      "id": "shtm_014341ab4bb5bf94d5b6936f86",
      "object": "shipping_term",
      "name": "Prepaid",
      "type": "carrier_rate_freight",
      "owner": {
        "object": "owner",
        "type": "system",
        "account": null
      },
      "flat_rate": null,
      "minimum_order_value": null,
      "free_shipping_service_levels": {
        "object": "list",
        "page_info": {
          "next_page_url": null,
          "previous_page_url": null,
          "has_next_page": false,
          "has_prev_page": false
        },
        "data": []
      },
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    },
    "priority": {
      "id": "pi_01fc435701244bb3978bfb77ff",
      "object": "priority",
      "code": "normal",
      "name": "Normal",
      "owner": {
        "object": "owner",
        "type": "system",
        "account": null
      },
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    },
    "sales_rep": {
      "id": "acus_01ea9983ddb41dacc44ecf997c",
      "object": "account_user",
      "status": "active",
      "role": {
        "id": "rl_01c16d2eb637c0d1f3a372937c",
        "object": "role",
        "name": "Admin",
        "type": "admin",
        "owner": {
          "object": "owner",
          "type": "account",
          "account": {
            "id": "ac_01148680966698341a9c0976db",
            "object": "account",
            "name": "Acme Inc.",
            "default_billing_address": null,
            "default_shipping_address": null,
            "branding": null,
            "portal": null,
            "created_at": "2026-05-10T00:00:00Z",
            "updated_at": "2026-05-10T00:23:00Z"
          }
        },
        "permissions": [
          "customers:create",
          "customers:read",
          "customers:update",
          "customers:delete"
        ],
        "created_at": "2026-05-10T00:00:00Z",
        "updated_at": "2026-05-10T00:23:00Z"
      },
      "department": null,
      "user": {
        "id": "us_0151164dcaea4cbded27b50aae",
        "object": "user",
        "email": "jdoe@augno.com",
        "name": "John Doe",
        "username": "jdoe",
        "email_verified_at": "2026-06-10T00:00:00Z",
        "image_url": "https://cdn.augno.com/avatars/us_0151164dcaea4cbded27b50aae.jpg",
        "created_at": "2026-05-10T00:00:00Z",
        "updated_at": "2026-05-10T00:23:00Z"
      },
      "last_used_at": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  },
  "notification_preferences": {
    "object": "customer_notification_preferences",
    "accepts_invoice_emails": true
  },
  "bill_to_address": {
    "id": "ad_012100950cfaa34aa0e0ad7258",
    "object": "address",
    "name": "Headquarters",
    "phone": null,
    "email": null,
    "type": "standard",
    "geolocation": {
      "id": "gl_013e4c26412103c6757ba71806",
      "object": "geolocation",
      "street_line_1": "4200 Industrial Pkwy",
      "street_line_2": null,
      "locality": "Columbus",
      "state": "OH",
      "postal_code": "43204",
      "country": "US"
    },
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "ship_to_address": {
    "id": "ad_012100950cfaa34aa0e0ad7258",
    "object": "address",
    "name": "Headquarters",
    "phone": null,
    "email": null,
    "type": "standard",
    "geolocation": {
      "id": "gl_013e4c26412103c6757ba71806",
      "object": "geolocation",
      "street_line_1": "4200 Industrial Pkwy",
      "street_line_2": null,
      "locality": "Columbus",
      "state": "OH",
      "postal_code": "43204",
      "country": "US"
    },
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "type": {
    "id": "acgp_018e88072d1320808dc979cfac",
    "object": "account_group",
    "type": "type_group",
    "name": "Wholesale Customers",
    "description": null,
    "commission_policy": "commission_applied",
    "freight_policy": "billed_freight",
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "price_groups": {
    "object": "list",
    "page_info": {
      "next_page_url": null,
      "previous_page_url": null,
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "id": "acgp_018e88072d1320808dc979cfac",
        "object": "account_group",
        "type": "type_group",
        "name": "Wholesale Customers",
        "description": null,
        "commission_policy": "commission_applied",
        "freight_policy": "billed_freight",
        "created_at": "2026-05-10T00:00:00Z",
        "updated_at": "2026-05-10T00:23:00Z"
      }
    ]
  },
  "parent_account": null,
  "child_accounts": null,
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Customers

Attributes

Used by