Square

The Square integration connects Square subscription memberships to RemyPass wallet passes.

Use this integration when customers buy or manage memberships through Square subscriptions and you want RemyPass to issue, update, and end digital passes automatically.

What RemyPass Does

• Reads Square customers and subscription plan variations from your connected Square account.
• Matches a Square customer to an existing RemyPass member or creates a new member.
• Issues the RemyPass pass template mapped to the customer's Square subscription plan.
• Optionally emails the issued pass to the customer.
• Updates the linked pass when the Square subscription becomes active, pauses, is cancelled, or is completed.
• Updates a linked RemyPass member's name or email when Square sends a customer update for a customer whose reference_id matches the RemyPass barcode value.
• Refreshes passes that use a mapped subscription plan name when Square sends a catalog update after the seller renames the plan.
• Marks the integration as disconnected and requiring reauthorization when Square reports OAuth access has been revoked.
• Records processed Square events so repeated webhook deliveries do not create duplicate passes.

Before You Connect

Make sure you have:

• Administrator access in RemyPass.
• A Square account with subscription plans configured.
• Customer records in Square with usable contact details, especially email addresses if you want RemyPass to email passes.
• A RemyPass pass template for each subscription membership you want to issue.

Setup Overview

1. Open Integrations in RemyPass.
2. Choose Square and connect your Square account.
3. Open Configure Square.
4. Enable Handle Square subscriptions.
5. Map each Square subscription plan variation to the RemyPass pass template that should be issued.
6. Choose whether passes issued from active subscriptions should be emailed automatically.
7. Add field mappings if pass fields should be filled from Square customer or subscription data.
8. Save the settings and test with one subscription before using the integration broadly.

Subscribe your Square webhook endpoint to subscription.created, subscription.updated, customer.updated, catalog.version.updated, and oauth.authorization.revoked.

Subscription Lifecycle

When Square sends a subscription event, RemyPass checks your mappings before changing a member or pass.

Square subscription state	RemyPass behavior
Active	Creates or updates the member and issues the mapped pass.
Paused	Deactivates the linked pass so it can no longer be used.
Cancelled	Ends the linked pass according to the cancellation state.
Completed	Ends the linked pass when the subscription has finished.

If a Square event does not match a configured plan mapping, RemyPass records it as ignored and does not issue a pass.

Field Mapping

Field mappings let you copy Square values into RemyPass pass fields. Common examples include:

• Customer name
• Customer email
• Square customer ID
• Square subscription ID
• Subscription plan name
• Subscription status

Use field mappings when your pass design needs Square-specific data printed on the pass or stored with the member record.

If a pass uses the subscription plan name as a mapped dynamic field, Square plan renames are applied after RemyPass receives catalog.version.updated.

Troubleshooting

Use Configure Square -> View Events in RemyPass to review Square events that RemyPass has processed.

If a pass was not issued:

• Check that Handle Square subscriptions is enabled.
• Check that the Square subscription plan variation is mapped to a valid pass template.
• Confirm the Square customer has enough contact data to create or match a RemyPass member.
• Review the event log to see whether the event was processed, ignored, or failed.
• Contact RemyPass support with the Square customer ID, subscription ID, and expected pass behavior.