Square Customer Integration w/Custom Fields

I have set up custom Customer fields in Square for my nonprofit political group that takes donations and sells things. When we are at a live event we can use Square Stand and it is easy to set up a customer and fill in these fields.

The problem is that we also need to collect some of this information online. I quickly found out that it is impossible to set up a Square Checkout page for an item that provides inputs for this info. I started building a custom website (using Umbraco V8) and have developed a custom Surface Controller that will display a form that provides inputs for this custom info. The intent was (on form submission) to use the Square Customer API to create/update a customer in Square, and then use the Checkout API to redirect the user to the pre-filled Square Checkout Page for the item.

The problem seems to be that the Square Customer API seems to not allow the return of custom fields when querying, nor does it seem to allow setting these custom fields when creating or updating a customer. Am I missing something?

I have also thought about going the other way, and creating database tables on my side to hold the master copy of the Customer information. When online, we could simply update this information directly to the SQL Server db. I could set up a web service on my side to add/update Customers when they are added by Square Stand, and set up the web hooks in Square to do this. But again, it appears that the Customer information Square pushes out when utilizing web hooks, does not include custom fields.

Is there some sort of smart solution out there?


Hi @perry4nc welcome to the forums!

Unfortunately the Customers API does not currently return or allow editing of custom fields. This is a common feature request and the team is working on it, but I do not currently have an ETA on when it will be available.

Thanks. I will say it is rather important for organizations like ours. For instance, we are required by North Carolina state law to collect Employer & Occupation when receiving money.

1 Like

Hi. Are there any updates on this feature request? Our organization would greatly benefit from being able to access custom customer fields via the API. We currently have a very error-prone manual input method that causes many issues for our customers and staff.

1 Like

:wave: This is a common feature request and the team is working on it, but I do not currently have an ETA on when it will be available.

I also have a client that needs to use Custom Fields through the API.

@Good, thanks for reaching out. Custom Fields on the API remains a priority for us. Will let you and the community know when we are closer to getting launching this.

Would you be interested in trying out the feature when we do an alpha release?

Also tagging @swingsandwings and @perry4nc for their interest in participating in the alpha program.

Sure, you can put me on the alpha.


Absolutely! Please add me to the list for the alpha program.

Ugh, landed here looking for same exact functionality. I cannot believe there’s no way to update custom field values for a customer via the API—figured that would be standard. Having to rework stuff now to get around it…

1 Like

Bump for this as well. Looking forward to the custom field being implemented. It would be helpful with automation that requires a custom field ID in Square.

Hi @immanuel

We are interested in the Alpha program. Read/Update access to Custom Fields through the API is a must for us.


Hi @immanuel,

We are interested in participating in the Alpha program as well.


Hi. Has there been any progress on this? As business ramps up, we are starting to struggle with ensuring accuracy of customer information via custom fields.

Hi @swingsandwings - Yes, we’re now preparing for kicking off the alpha program. Let me DM you for next steps.

Hi @immanuel, can we also participate in the Alpha program?

Hello - and welcome to the forum!

Let me DM you on here and we can get going!

  • Immanuel

@immanuel Please add me to Alpha program.

Hello @pinspiration - let me DM you to talk through the process.

1 Like