Stay AI icon

Stay AI

Subscription retention and customer engagement platform for ecommerce brands.

2 triggers5 searches20 actionsPollingAuth: API key

AI-assisted documentation9 min read

This documentation is compiled from our integration source code, internal specs for Stay AI, its official API documentation and anonymized requests logs we collect from our support team[2].

Open Stay AI on WEXTL →

Before you set up the credential, make sure you have an active Stay AI account and an API access token from your account settings ready.[3]

  • API KeypasswordRequired

    Access API Keys by navigating to by navigating to Settings -> API Keys. Keys are managed inside the Merchant Portal.

    [1]
  1. Log in to your WEXTL account, add the Stay AI node module to your workflow, and click Create new credential.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your Stay AI account, or follow the on-screen instructions to create the credential.
  4. If prompted, authenticate your account and confirm access.
  5. If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Notes

Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →

Watch OrdersTrigger
Output fields[3]
FieldType
Order IDtext
Order nametext
Customer IDtext
Subscription IDtext
Created atdate
Updated atdate
Fulfillment statustext
Currencytext
Total pricenumber
Cart discount amountnumber
Current total taxnumber
Total shipping pricenumber
Addressobject
Ziptext
Citytext
Phonetext
Companytext
Countrytext
Address 1text
Address 2text
Last nametext
Provincetext
First nametext
Tagstext
Line itemsarray
Watch SubscriptionsTrigger
Output fields[3]
FieldType
IDtext
Subscription IDtext
Customer IDtext
Email addressemail
Created atdate
Updated atdate
Next billing datedate
Paused untildate
Churned atdate
Cancelled atdate
Cancellation reasontext
Pricenumber
Delivery pricenumber
Currencytext
Statustext
Order interval frequencynumber
Order interval unittext
Order notestext
Line itemsarray
Get a SubscriptionAction
Input fields[3]
FieldType
Subscription IDRequired
choice
Output fields[3]
FieldType
IDtext
Subscription IDtext
Customer IDtext
Email addressemail
Created atdate
Updated atdate
Next billing datedate
Paused untildate
Churned atdate
Cancelled atdate
Cancellation reasontext
Pricenumber
Delivery pricenumber
Currencytext
Statustext
Order interval frequencynumber
Order interval unittext
Order notestext
Line itemsarray
Get an OrderAction
Input fields[3]
FieldType
Order IDRequired
choice
Output fields[3]
FieldType
Order IDtext
Order nametext
Customer IDtext
Subscription IDtext
Created atdate
Updated atdate
Fulfillment statustext
Currencytext
Total pricenumber
Cart discount amountnumber
Current total taxnumber
Total shipping pricenumber
Addressobject
Ziptext
Citytext
Phonetext
Companytext
Countrytext
Address 1text
Address 2text
Last nametext
Provincetext
First nametext
Tagstext
Line itemsarray
List Subscription MetadataSearch
Input fields[3]
FieldType
Subscription IDRequired
choice
Limitnumber
Output fields[3]
FieldType
IDtext
Account IDtext
Created atdate
Updated atdate
Subscription contract IDtext
Search OrdersSearch
Input fields[3]
FieldType
Created Date Mindate
Created Date Maxdate
Updated Date Mindate
Updated Date Maxdate
Field Name For Sortingchoice
Sorting Directionchoice
Limitnumber
Output fields[3]
FieldType
Order IDtext
Order nametext
Customer IDtext
Subscription IDtext
Created atdate
Updated atdate
Fulfillment statustext
Currencytext
Total pricenumber
Cart discount amountnumber
Current total taxnumber
Total shipping pricenumber
Addressobject
Ziptext
Citytext
Phonetext
Companytext
Countrytext
Address 1text
Address 2text
Last nametext
Provincetext
First nametext
Tagstext
Line itemsarray
Search SubscriptionsSearch
Input fields[3]
FieldType
Customer Emailemail
Subscription Statuschoice
Created Date Mindate
Created Date Maxdate
Updated Date Mindate
Updated Date Maxdate
Next Billing Date Mindate
Next Billing Date Maxdate
Field Name For Sortingchoice
Sorting Directionchoice
Limitnumber
Output fields[3]
FieldType
IDtext
Subscription IDtext
Customer IDtext
Email addressemail
Created atdate
Updated atdate
Next billing datedate
Paused untildate
Churned atdate
Cancelled atdate
Cancellation reasontext
Pricenumber
Delivery pricenumber
Currencytext
Statustext
Order interval frequencynumber
Order interval unittext
Order notestext
Line itemsarray
Add Subscription DiscountAction
Input fields[3]
FieldType
Subscription IDRequired
choice
Redeem CodeRequired
text
Initiating Actorchoice
Output fields[3]
FieldType
Successboolean
Add Subscription MetadataAction
Input fields[3]
FieldType
Subscription IDRequired
choice
Meta Data KeyRequired
text
Meta Data Valuetext
Output fields[3]
FieldType
IDtext
Account IDtext
Created atdate
Updated atdate
Subscription contract IDtext
Add Subscription Order LinesAction
Input fields[3]
FieldType
Subscription IDRequired
choice
LinesRequired
array
Output fields[3]
FieldType
Successboolean
Cancel a SubscriptionAction
Input fields[3]
FieldType
Subscription IDRequired
choice
Cancellation Reasonsarray
Cancellation Reasontext
Initiating Actorchoice
Output fields[3]
FieldType
Successboolean
Create a Portal LinkAction
Create a Subscription OrderAction
Input fields[3]
FieldType
Subscription IDRequired
choice
Output fields[3]
FieldType
Successboolean
Delete Subscription MetadataAction
Input fields[3]
FieldType
Subscription IDRequired
choice
Meta Data IDRequired
text
Meta Data KeyRequired
text
Meta Data Valuetext
Output fields[3]
FieldType
Successboolean
Generate an Upcoming OrderAction
Input fields[3]
FieldType
Subscription IDRequired
choice
Output fields[3]
FieldType
Successboolean
Make an API Calluniversal
Input fields[3]
FieldType
URLRequired
text
MethodRequired
choice
Headersarray
Headerobject
Query Stringarray
Parameterobject
Bodytext
Output fields[3]
FieldType
Bodytext
Headersobject
Status codenumber
Pause a SubscriptionAction
Input fields[3]
FieldType
Subscription IDRequired
choice
Paused Until DateRequired
date
Initiating Actorchoice
Output fields[3]
FieldType
Successboolean
Reactivate a SubscriptionAction
Input fields[3]
FieldType
Subscription IDRequired
choice
Initiating Actorchoice
Output fields[3]
FieldType
Successboolean
Remove a Subscription DiscountAction
Input fields[3]
FieldType
Subscription IDRequired
choice
Discount IDRequired
text
Output fields[3]
FieldType
Successboolean
Remove Subscription Order LinesAction
Input fields[3]
FieldType
Subscription IDRequired
choice
Line Item IDsRequired
array
Line Item IDtext
Output fields[3]
FieldType
Successboolean
Set a Subscription Shipping AddressAction
Input fields[3]
FieldType
Subscription IDRequired
choice
First NameRequired
text
Last NameRequired
text
Address Line 1Required
text
Address Line 2text
CityRequired
text
CountryRequired
text
ProvinceRequired
text
Province CodeRequired
text
Zip CodeRequired
text
Shipping Address PhoneRequired
text
Output fields[3]
FieldType
Successboolean
Set Next Billing DateAction
Input fields[3]
FieldType
Subscription IDRequired
choice
Next Billing DateRequired
date
Output fields[3]
FieldType
Successboolean
Skip the Next OrderAction
Input fields[3]
FieldType
Subscription IDRequired
choice
Output fields[3]
FieldType
Successboolean
Unpause a SubscriptionAction
Input fields[3]
FieldType
Subscription IDRequired
choice
Initiating Actorchoice
Output fields[3]
FieldType
Successboolean
Update a Subscription Order LineAction
Input fields[3]
FieldType
Subscription IDRequired
choice
Line IDRequired
text
PriceRequired
number
QuantityRequired
number
Output fields[3]
FieldType
Successboolean
Update Subscription FrequencyAction
Input fields[3]
FieldType
Subscription IDRequired
choice
Billing Period ValueRequired
number
Interval UnitRequired
choice
Initiating Actorchoice
Output fields[3]
FieldType
IDtext
Created atdate
Updated atdate
Shopify subscription contract IDtext
Statustext
Shopify created attext
Next billing datedate
Scheduled billing datedate
Paused untildate
Dunning started attext
Dunning exited attext
Cancelled attext
Cancellation reasonstext
Billing policyobject
Intervaltext
Interval countnumber
Anchorstext
Assigned pricing policytext
Addresstext
Gift addresstext
Line countnumber
Origin order IDtext
17other output fields
Update Subscription Order NotesAction
Input fields[3]
FieldType
Subscription IDRequired
choice
Order NotesRequired
text

Look for Stay AI templates in the WEXTL template library.

Browse templates →
  1. WEXTL® Stay AI Source Code connector implementation.
  2. Our users use cases and automations.
  3. Official API Documentation for Stay AI.
  4. WEXTL® visual workflow builder data.

Last updated: Jul 24, 2026 18:13