When you connect your Square account in Submatic you will be presented with a list of permissions. This list covers the functions that Submatic must access to perform its job in working with Square.
Note that all of the processes in place for our Square integration are specific to the customers and orders that you process with Submatic (subscription/membership and package orders only). For additional information you may also refer to the Square OAuth Permissions Reference.
Some permissions are "Read-only" while others are "Write". These permissions are listed separately on your authorization page. Read-only permissions allow access to view data, and Write permissions give access to create new data/records. We need to be able to "Read" all data that we "Write". So if we create orders (a Write permission) then we will also need to view orders (a Read-only permission). Therefore there are two distinct permission requirements that are associated with orders: "View your Square orders" (Read-only) and "Create or update your Square orders" (Write).
Below is a recap of the permissions that we request when connecting to your Square account with additional context and information.
- View your payments history: In order for Submatic to process payments and refunds, as well as access credit card on file in Square this is required. This is also needed as part of the functionality that we handle associated with orders created at the POS (redemption tracking and Linked POS Orders). This is a Read-only permission.
- Take payments and make refunds: This is similar to above though it is listed separately because it is a "Write" permission. We need to be able to create payments in Square.
- View your Square orders: Similar to the first permission listed above. Giving Submatic access to view orders allows for identification of specific products sold (whereas payments alone does not provide this data). This is also needed as part of our order creation process. This is a Read-only permission.
- Create or update your Square orders: Every time Submatic processes a payment in Square we create an order. If the payment is declined we void the order. This is a write permission.
- View your item library: The item library in Square's API includes not only products ("Items") but other things like Discounts, Product Sets, and Pricing Rules. We need to be able to retrieve these records. This is a Read-only permission.
- Modify your item library: Submatic does not create or edit products in your Square account, but we do create Discounts, Product Sets, and Pricing Rules. We need access to do so via the Write permission.
- View your customer information: We need to access customer data to ensure the Submatic customer database stays in sync with your Square customer database (this is specific to customers that have purchased a subscription/membership or package). We also need to attach discounts/benefits to customer profiles. This is a Read-only permission.
- Modify your customer information: We modify customer information in Square only if you update that customer record in Submatic. For example if you change a customer name or add a birthday to the customer profile in Submatic, that data will appear in Square. This is a Write permission.
- View your merchant profile information: We need to access basic information about your business and verify that your Square merchant account is active. This is a Read-only permission.
- View your discount codes and redemptions: In addition to standard discounts in Square (which are part of the Item Library, covered via a separate permission above) we also use Discount Codes. These serve a similar purpose as Discounts in Square but are functionally different and require a separate permission setting to access. We need to be able to view discount codes and redemptions in your store. This is a Read-only permission.
- Modify my discount codes and redemptions: Same as above except this is a Write permission. Submatic needs to be able to create new Discount codes in your store.
The below five permission settings are specific to Square Appointments. Submatic allows for purchasers of subscriptions or packages of bookable services to book appointments using service credits. The below permissions are all associated with this functionality and are all required for Submatic to perform this correctly. While you may not use Square Appointments, the below permissions will appear for you when you authorize the connection between Submatic and Square (we do not differentiate permission requests for different businesses).
- View your Appointments settings
- View your Appointment details
- View all appointments and calendar events
- Create and update appointment details
- Create and update all appointment details