retrieve-customer-group-response.md

Retrieve Customer Group Response

Defines the fields that are included in the response body of a request to the RetrieveCustomerGroup endpoint.

Either errors or group is present in a given response (never both).

Structure

RetrieveCustomerGroupResponse

Fields

Name	Type	Tags	Description	Getter
Errors	List<Error>	Optional	Any errors that occurred during the request.	List getErrors()
Group	CustomerGroup	Optional	Represents a group of customer profiles. Customer groups can be created, be modified, and have their membership defined using the Customers API or within the Customer Directory in the Square Seller Dashboard or Point of Sale.	CustomerGroup getGroup()

Example (as JSON)

{
  "group": {
    "created_at": "2020-04-13T21:54:57.863Z",
    "id": "2TAT3CMH4Q0A9M87XJZED0WMR3",
    "name": "Loyal Customers",
    "updated_at": "2020-04-13T21:54:58Z"
  },
  "errors": [
    {
      "category": "MERCHANT_SUBSCRIPTION_ERROR",
      "code": "INVALID_EXPIRATION",
      "detail": "detail6",
      "field": "field4"
    }
  ]
}