Stay AI Connector

Connect Stay AI so your agent can look up subscription context and run guided subscription actions inside Flows.

Use this Connector when support conversations depend on live subscription details, upcoming billing dates, paused or cancelled status, or customer requests to change a recurring order.

Common use cases

Look up a customer’s Stay AI subscriptions by email.
Check subscription status, products, quantities, prices, and upcoming billing dates.
Cancel a subscription after the customer confirms the request.
Pause or unpause a subscription.
Skip the next scheduled order.

For high-impact actions like cancellation, use a Flow that confirms the customer identity and captures approval before calling the Connector.

Before you begin

Before connecting Stay AI, make sure:

You can access the Stay AI Merchant Portal for the store you want to connect.
Your team knows whether Applied should only read subscription data or also update subscriptions.
You have a test customer or test subscription available for validation.

If your team manages multiple Stay AI stores, create one Connector per store.

Get a Stay AI API key

Stay AI API keys are created in the Stay AI Merchant Portal.

In Stay AI, open Settings.
Go to API Keys.
Click New API Key.
Enter a name such as Applied Labs.
Add a short description and the email address of the API key admin.
Choose the scopes Applied needs.
Create the key and copy it.

Use the narrowest scopes that cover the Flows you plan to run:

Read Subscriptions is required for subscription lookups.
Update Subscriptions is required for cancellation, pause, unpause, and skip-next-order actions.

Stay AI also offers broader scopes such as All, but use them only if your team explicitly wants broad API access. Applied does not need a separate OAuth token for this Connector; paste the Stay AI API key into Applied’s API token field.

Keep the key private. Treat it like a password and rotate it if it may have been shared outside your approved admin group.

Connect Stay AI in Applied

Open Connectors.
Click New.
Choose Stay AI.
Paste the Stay AI API key into the API token field.
Create the connection.

Applied sends the key to Stay AI as the X-RETEXTION-ACCESS-TOKEN request header when it calls the Stay AI API.

Use Stay AI in Flows

Stay AI can be used in Flows when a workflow needs to:

Read subscriptions for a customer email address.
Filter subscription lookups by ACTIVE, PAUSED, or CANCELLED status.
Cancel a subscription with optional cancellation reasons.
Pause a subscription until a specific date.
Resume a paused subscription.
Skip the next order for a subscription.

Design Flows so they collect the customer email address before lookup. For write actions, collect the subscription ID from a prior lookup step instead of asking a customer to provide it manually.

Validate the connection

After setup:

Look up a test customer’s subscription by email.
Confirm the returned subscription status, next billing date, and line items match Stay AI.
If update actions are enabled, run one low-risk test Flow on a test subscription.
Confirm the change appears in Stay AI.

Do not validate cancellation or skip-order Flows on a live customer unless your team is ready for the subscription change to happen.

Reconnecting Stay AI

Reconnect Stay AI when:

The API key was rotated.
Required scopes changed.
Stay AI returns authentication or permission errors.
The team needs to connect a different Stay AI store.

When possible, update the existing connection instead of creating a duplicate Connector for the same store.

Common issues

Stay AI says the token is invalid

Confirm the key was copied from Settings > API Keys in the Stay AI Merchant Portal and pasted into Applied without extra spaces.

Subscription lookup works, but updates fail

Review the API key scopes. Read-only keys can look up subscriptions but cannot cancel, pause, unpause, or skip orders. Add Update Subscriptions or rotate the key with the correct scope.

The wrong subscription was updated

Use a Flow lookup step to select the subscription ID from Stay AI before running an update action. Customer-visible order numbers and Shopify IDs can differ from the internal subscription ID shown in Connector outputs.