Customers API

Get Started Using the Customers API

You can use the Customers API for customer-related tasks that include, but are not limited to, the following:

  • Keeping records of customer profiles in a Square account.

  • Synchronizing the customer data.

  • Searching for customers using supported query filters.

  • Integrating customer data with other Square services to facilitate the customer purchasing experience, including saving cards on file and charging them for ensuing purchases.

    Important

    To save customer contact information or cards on file, you must seek explicit permission from the customer. This means you should enable an option for the customer to agree explicitly to have the contact information or the credit and debit cards stored on file. Storing customer contact information or card information without explicit consent and any other form of abuse of customer information might result in your application being disabled without notice.

Prerequisites Permalink Get a link to this section

To use the Customers API, you must meet the following prerequisites:

  • You have a Square account enabled for payment processing. If you have a Square account, but have not enabled payment processing (or you are not sure), see squareup.com/activate. To use OAuth, you need CUSTOMERS_READ permission.

  • You have a valid access token. For testing, use Sandbox credentials whenever possible. For more information, see Square API Access Tokens.

  • You use HTTPS to make production Square API calls. Although, you can make HTTP calls for developing and testing on localhost.

  • You follow best practices for collecting information. Abuse of customer contact information might result in your application being disabled without notice.