Outseta integration guide
VerifiedHow to connect Outseta to WEXTL and use its 6 triggers and 144 actions in your workflows. About Outseta: Membership, CRM and billing for SaaS companies.
- 6 triggers
- 59 searches
- 85 actions
- Instant (webhooks)
- Auth: API key
AI-assisted documentation53 min read
This documentation is compiled from our integration source code, internal specs for Outseta, its official API documentation and anonymized requests logs we collect from our support team[2].
Requirements
Get your Outseta credentials
- SubdomaintextRequired
Only the part before .outseta.com, no https:// and no .outseta.com. For acme.outseta.com, enter acme.[1]
- API KeytextRequired
In Outseta, open Settings, then Integrations, then API Keys, and add a key. Copy the key and its secret right away.[1]
- API SecretpasswordRequired
The secret shown once when you created the API key.[1]
Connect Outseta in WEXTL
- Log in to your WEXTL account, add the Outseta node module to your workflow, and click Create new credential.Instant triggers use webhooks. Click Create a webhook first when adding one, then create the credential.
- Optional: In the Credential name field, enter a name for the credential.
- Enter the authentication credentials you copied from your Outseta account, or follow the on-screen instructions to create the credential.
- If prompted, authenticate your account and confirm access.
- If you want to make changes to your credential in the future, follow the steps in Manage credentials →
Outseta triggers and actions on WEXTL
The list below is a reference of every Outseta node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Each Outseta node module below opens to reveal its input parameters, outputs, and connection requirements.
Watch Activities
TriggerScheduled watch on the activity log.
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Title | text |
| Description | text |
| Activity Data | text |
| Activity Date Time | date |
| Activity Type | number |
2other output fields
Watch Events (Instant)
TriggerInstant trigger for Outseta activity notifications.
| Field | Type |
|---|---|
| Object Type | text |
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Name | text |
| Client Identifier | text |
60other output fields
Watch New Accounts
TriggerPolled trigger for freshly added accounts.
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Name | text |
| Client Identifier | text |
| Currency | text |
42other output fields
Watch New Deals
TriggerNew deals found on a schedule.
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| Amount | number |
| Due Date | date |
| Assigned To Person Client Identifier | text |
| Weight | number |
6other output fields
Watch New People
TriggerNewly added people, picked up by polling.
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| text | |
| First Name | text |
| Last Name | text |
| Mailing Address | object |
| UID | text |
| Created | date |
| Updated | date |
| Address Line1 | text |
| Address Line2 | text |
| Address Line3 | text |
| City | text |
| State | text |
| Postal Code | text |
| Country | text |
| Password Must Change | boolean |
18other output fields
Watch New Support Cases
TriggerNew support cases found by polling.
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Submitted Date Time | date |
| Last Activity | text |
| From Person | object |
| UID | text |
| Created | date |
| Updated | date |
| text | |
| First Name | text |
| Last Name | text |
| Password Must Change | boolean |
| Phone Mobile | text |
| Phone Work | text |
| Title | text |
| Assigned To Person Client Identifier | text |
| Subject | text |
10other output fields
Get a Broadcast
SearchOne email broadcast and its schedule.
| Field | Type |
|---|---|
BroadcastRequired | choice |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Send Date Time | date |
| Next Run Date Time | date |
| Campaign | object |
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| From Name | text |
| From Email | text |
| Campaign Type | number |
| Message | object |
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| Subject | text |
| Preview Text | text |
| Body | text |
| Design | text |
| Count Sent | number |
| Count Delivered | number |
| Recipient Data | text |
5other output fields
Get a Custom Attribute Definition
SearchSetup of one specific custom field.
| Field | Type |
|---|---|
Definition IDRequired | text |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Control Type | text |
| Control Params | text |
| Label | text |
| System Name | text |
| Entity Type | number |
2other output fields
Get a Deal
SearchSingle deal with amount and stage.
| Field | Type |
|---|---|
DealRequired | choice |
| Fields | text |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| Amount | number |
| Due Date | date |
| Assigned To Person Client Identifier | text |
| Weight | number |
6other output fields
Get a Discount Coupon
SearchCoupon details from Outseta billing.
| Field | Type |
|---|---|
Discount CouponRequired | choice |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Unique Identifier | text |
| Name | text |
| Is Active | boolean |
| Amount Off | number |
| Percent Off | number |
8other output fields
Get a Drip Campaign
SearchOne drip sequence and its triggers.
| Field | Type |
|---|---|
Drip CampaignRequired | choice |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Is Active | boolean |
| Campaign | object |
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| From Name | text |
| From Email | text |
| Campaign Type | number |
| Trigger ID | number |
| Trigger Start Value | text |
| Trigger Stop Value | text |
3other output fields
Get a Drip Campaign Message
SearchSingle email step of a drip campaign.
| Field | Type |
|---|---|
Drip CampaignRequired | choice |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Drip Campaign | object |
| UID | text |
| Created | date |
| Updated | date |
| Is Active | boolean |
| Trigger ID | number |
| Trigger Start Value | text |
| Trigger Stop Value | text |
| Allow Repeat Processing | boolean |
| Start Drip To Existing Members | boolean |
| Mark Existing Recipients Done | boolean |
| Message | object |
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| Subject | text |
| Preview Text | text |
| Body | text |
| Design | text |
| Count Sent | number |
| Count Delivered | number |
| Delay From Prior Day | number |
| Delay In Hours | number |
| Weight | number |
Get a Knowledge Base Article
SearchHelp article text and status.
| Field | Type |
|---|---|
ArticleRequired | choice |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Weight | number |
| Title | text |
| Body | text |
| Support Article Status | number |
| Category | object |
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| Description | text |
| Weight | number |
1other output field
Get a Person
SearchContact details for one person.
| Field | Type |
|---|---|
PersonRequired | choice |
| Fields | text |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| text | |
| First Name | text |
| Last Name | text |
| Mailing Address | object |
| UID | text |
| Created | date |
| Updated | date |
| Address Line1 | text |
| Address Line2 | text |
| Address Line3 | text |
| City | text |
| State | text |
| Postal Code | text |
| Country | text |
| Password Must Change | boolean |
18other output fields
Get a Plan
SearchSubscription plan settings in Outseta billing.
| Field | Type |
|---|---|
PlanRequired | choice |
| Fields | text |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| Description | text |
| Plan Family | object |
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| Is Active | boolean |
| Is Default | boolean |
| Account Registration Mode | number |
| Is Quantity Editable | boolean |
20other output fields
Get a Plan Family
SearchPlan group with its flags.
| Field | Type |
|---|---|
Plan FamilyRequired | choice |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| Is Active | boolean |
| Is Default | boolean |
Get a Product
SearchProduct record from Stripe billing.
| Field | Type |
|---|---|
ProductRequired | choice |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Name | text |
| Default Price ID | text |
| Description | text |
19other output fields
Get a Product Family
SearchProduct grouping and its billing anchors.
| Field | Type |
|---|---|
Product FamilyRequired | choice |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| Is Active | boolean |
| Is Default | boolean |
| Billing Cycle Anchor Day Of Month | number |
| Billing Cycle Anchor Hour | number |
1other output field
Get a Promotion Code
SearchRedeemable code with its limits.
| Field | Type |
|---|---|
Promotion CodeRequired | choice |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Account | object |
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Name | text |
| Client Identifier | text |
| Currency | text |
| Invoice Notes | text |
| Is Demo | boolean |
| Active | boolean |
| Code | text |
8other output fields
Get a Stripe Coupon
SearchDiscount terms of one coupon.
| Field | Type |
|---|---|
CouponRequired | choice |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Amount Off | number |
| Currency | text |
| Duration | text |
11other output fields
Get a Stripe Invoice
SearchStripe invoice amounts and attempts.
| Field | Type |
|---|---|
InvoiceRequired | choice |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Amount Due | number |
| Amount Paid | number |
| Amount Shipping | number |
36other output fields
Get a Stripe Payment Method
SearchCard details of a stored payment method.
| Field | Type |
|---|---|
Payment MethodRequired | choice |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Account | object |
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Name | text |
| Client Identifier | text |
| Currency | text |
| Invoice Notes | text |
| Is Demo | boolean |
| Card Brand | text |
| Card Exp Month | number |
6other output fields
Get a Stripe Price
SearchPrice setup from Stripe billing.
| Field | Type |
|---|---|
PriceRequired | choice |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Billing Scheme | text |
| Currency | text |
| Custom Unit Amount Maximum | number |
23other output fields
Get a Stripe Subscription Change Preview
SearchDry run of a Stripe plan change.
| Field | Type |
|---|---|
SubscriptionRequired | choice |
ItemsRequired | array |
| Item | object |
| As Of | date |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Amount Due | number |
| Amount Paid | number |
| Amount Shipping | number |
36other output fields
Get a Subscription
SearchOne subscription with plan and dates.
| Field | Type |
|---|---|
SubscriptionRequired | choice |
| Fields | text |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Billing Renewal Term | number |
| Account | object |
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Name | text |
| Client Identifier | text |
| Currency | text |
| Invoice Notes | text |
| Is Demo | boolean |
| Plan | object |
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| Description | text |
| Account Registration Mode | number |
| Is Quantity Editable | boolean |
| Minimum Quantity | number |
| Maximum People | number |
| Monthly Rate | number |
| Quantity | number |
| Start Date | date |
10other output fields
Get a Subscription Add-on
SearchExtra product tied to a subscription.
| Field | Type |
|---|---|
Subscription Add-onRequired | choice |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Billing Renewal Term | number |
| Subscription | object |
| UID | text |
| Created | date |
| Updated | date |
| Billing Renewal Term | number |
| Quantity | number |
| Start Date | date |
| End Date | date |
| Expiration Date | date |
| Renewal Date | date |
| New Required Quantity | number |
| Add On | object |
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| Billing Add On Type | number |
| Is Quantity Editable | boolean |
| Minimum Quantity | number |
| Monthly Rate | number |
| Annual Rate | number |
| Setup Fee | number |
| Quantity | number |
| Start Date | date |
5other output fields
Get a Subscription Change Preview
SearchDry run of a plan change.
| Field | Type |
|---|---|
AccountRequired | choice |
PlanRequired | choice |
Billing TermRequired | choice |
| Quantity | number |
| Expiration Date | date |
| Start Immediately | boolean |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Billing Renewal Term | number |
| Account | object |
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Name | text |
| Client Identifier | text |
| Currency | text |
| Invoice Notes | text |
| Is Demo | boolean |
| Plan | object |
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| Description | text |
| Account Registration Mode | number |
| Is Quantity Editable | boolean |
| Minimum Quantity | number |
| Maximum People | number |
| Monthly Rate | number |
| Quantity | number |
| Start Date | date |
10other output fields
Get a Support Case
SearchSupport case with its text and timing.
| Field | Type |
|---|---|
Support CaseRequired | choice |
| Fields | text |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Submitted Date Time | date |
| Last Activity | text |
| From Person | object |
| UID | text |
| Created | date |
| Updated | date |
| text | |
| First Name | text |
| Last Name | text |
| Password Must Change | boolean |
| Phone Mobile | text |
| Phone Work | text |
| Title | text |
| Assigned To Person Client Identifier | text |
| Subject | text |
10other output fields
Get a Tag
SearchTag name and colour details.
| Field | Type |
|---|---|
TagRequired | choice |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| System Name | text |
| System Description | text |
| Tag Color | number |
| Entity Type | number |
Get an Account
SearchSingle account with optional field selection.
| Field | Type |
|---|---|
AccountRequired | choice |
| Fields | text |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Name | text |
| Client Identifier | text |
| Currency | text |
42other output fields
Get an Email List
SearchSubscriber list with its welcome settings.
| Field | Type |
|---|---|
Email ListRequired | choice |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| Description | text |
| Welcome Subject | text |
| Welcome Body | text |
| Welcome From Name | text |
10other output fields
Get an Email Template
SearchSaved template content from Outseta.
| Field | Type |
|---|---|
TemplateRequired | choice |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| Subject | text |
| Body | text |
| Design | text |
| Description | text |
5other output fields
Get an Invoice
SearchInvoice with status and balance.
| Field | Type |
|---|---|
InvoiceRequired | choice |
| Fields | text |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Invoice Date | date |
| Payment Reminder Sent Date | date |
| Number | number |
| Billing Invoice Status | number |
| Subscription | object |
| UID | text |
| Created | date |
| Updated | date |
| Billing Renewal Term | number |
| Quantity | number |
| Start Date | date |
| End Date | date |
| Expiration Date | date |
| Renewal Date | date |
| New Required Quantity | number |
17other output fields
List Account Transactions
SearchBilling history lines for one account.
| Field | Type |
|---|---|
AccountRequired | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Transaction Date | date |
| Billing Transaction Type | number |
| Amount | number |
| Is Captured | boolean |
| Is Electronic Transaction | boolean |
List Accounts
SearchAccounts filtered by name, stage or segment.
| Field | Type |
|---|---|
LimitRequired | number |
| Search | text |
| Account Stage | choice |
| Segment ID | text |
| Fields | text |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Name | text |
| Client Identifier | text |
| Currency | text |
42other output fields
List Activities
SearchActivity log entries within a time window.
| Field | Type |
|---|---|
LimitRequired | number |
| Activity Types | choice |
| Entity Type | choice |
| Entity ID | text |
| From | date |
| To | date |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Title | text |
| Description | text |
| Activity Data | text |
| Activity Date Time | date |
| Activity Type | number |
2other output fields
List Broadcasts
SearchEmail broadcasts narrowed by tag.
| Field | Type |
|---|---|
LimitRequired | number |
| Tag | choice |
| Without Tag ID | text |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Send Date Time | date |
| Next Run Date Time | date |
| Campaign | object |
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| From Name | text |
| From Email | text |
| Campaign Type | number |
| Message | object |
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| Subject | text |
| Preview Text | text |
| Body | text |
| Design | text |
| Count Sent | number |
| Count Delivered | number |
| Recipient Data | text |
5other output fields
List Custom Attribute Definitions
SearchCustom fields set up for one kind of record.
| Field | Type |
|---|---|
Record TypeRequired | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Control Type | text |
| Control Params | text |
| Label | text |
| System Name | text |
| Entity Type | number |
2other output fields
List Deals
SearchDeals filtered by name or owner.
| Field | Type |
|---|---|
LimitRequired | number |
| Search | text |
| Owner ID | text |
| Fields | text |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| Amount | number |
| Due Date | date |
| Assigned To Person Client Identifier | text |
| Weight | number |
6other output fields
List Discount Coupon Redemptions
SearchAccounts that used a coupon, with dates.
| Field | Type |
|---|---|
Discount CouponRequired | choice |
LimitRequired | number |
| Active | choice |
| Search | text |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Redeemed Date | date |
| Expire Date | date |
List Discount Coupons
SearchDiscount coupons filtered by code, plan or status.
| Field | Type |
|---|---|
LimitRequired | number |
| Search | text |
| Can Be Redeemed | choice |
| Plan | choice |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Unique Identifier | text |
| Name | text |
| Is Active | boolean |
| Amount Off | number |
| Percent Off | number |
8other output fields
List Drip Campaigns
SearchDrip sequences and whether they are on.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Is Active | boolean |
| Campaign | object |
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| From Name | text |
| From Email | text |
| Campaign Type | number |
| Trigger ID | number |
| Trigger Start Value | text |
| Trigger Stop Value | text |
3other output fields
List Email List Subscribers
SearchSubscribers of a mailing list with sign-up dates.
| Field | Type |
|---|---|
Email ListRequired | choice |
LimitRequired | number |
| Search | text |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Email List Subscriber Status | number |
| Subscribed Date | date |
| Confirmed Date | date |
| Confirmation Notes | text |
| Unsubscribed Date | date |
8other output fields
List Email Lists
SearchSubscriber lists in Outseta.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| Description | text |
| Welcome Subject | text |
| Welcome Body | text |
| Welcome From Name | text |
10other output fields
List Email Templates
SearchSaved email content with names and subjects.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| Subject | text |
| Body | text |
| Design | text |
| Description | text |
5other output fields
List Invoices
SearchInvoices filtered by minimum amount.
| Field | Type |
|---|---|
LimitRequired | number |
| Amount At Least | number |
| Exclude Invoice ID | text |
| Fields | text |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Invoice Date | date |
| Payment Reminder Sent Date | date |
| Number | number |
| Billing Invoice Status | number |
| Subscription | object |
| UID | text |
| Created | date |
| Updated | date |
| Billing Renewal Term | number |
| Quantity | number |
| Start Date | date |
| End Date | date |
| Expiration Date | date |
| Renewal Date | date |
| New Required Quantity | number |
17other output fields
List Knowledge Base Articles
SearchHelp articles filtered by text and tag.
| Field | Type |
|---|---|
LimitRequired | number |
| Search | text |
| Tag | choice |
| Without Tag ID | text |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Weight | number |
| Title | text |
| Body | text |
| Support Article Status | number |
| Category | object |
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| Description | text |
| Weight | number |
1other output field
List Knowledge Base Categories
SearchGroupings for help articles.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| Description | text |
| Weight | number |
List People
SearchPeople matched by name or email.
| Field | Type |
|---|---|
LimitRequired | number |
| Search | text |
| text | |
| Fields | text |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| text | |
| First Name | text |
| Last Name | text |
| Mailing Address | object |
| UID | text |
| Created | date |
| Updated | date |
| Address Line1 | text |
| Address Line2 | text |
| Address Line3 | text |
| City | text |
| State | text |
| Postal Code | text |
| Country | text |
| Password Must Change | boolean |
18other output fields
List Plan Families
SearchGroups of plans with their flags.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| Is Active | boolean |
| Is Default | boolean |
List Plans
SearchPlans filtered by family.
| Field | Type |
|---|---|
LimitRequired | number |
| Plan Family | choice |
| Fields | text |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| Description | text |
| Plan Family | object |
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| Is Active | boolean |
| Is Default | boolean |
| Account Registration Mode | number |
| Is Quantity Editable | boolean |
20other output fields
List Product Families
SearchProduct groupings from Stripe billing.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| Is Active | boolean |
| Is Default | boolean |
| Billing Cycle Anchor Day Of Month | number |
| Billing Cycle Anchor Hour | number |
1other output field
List Products
SearchProduct entries in Stripe billing.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Name | text |
| Default Price ID | text |
| Description | text |
19other output fields
List Promotion Codes
SearchRedeemable codes in Stripe billing.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Account | object |
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Name | text |
| Client Identifier | text |
| Currency | text |
| Invoice Notes | text |
| Is Demo | boolean |
| Active | boolean |
| Code | text |
8other output fields
List Stripe Coupon Redemptions
SearchRedemptions of one Stripe coupon with checkout and invoice IDs.
| Field | Type |
|---|---|
CouponRequired | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Checkout Session ID | text |
| End | text |
| Invoice ID | text |
8other output fields
List Stripe Coupons
SearchStripe billing coupons with their discount terms.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Amount Off | number |
| Currency | text |
| Duration | text |
11other output fields
List Stripe Invoice Line Items
SearchIndividual invoice lines for one account or all.
| Field | Type |
|---|---|
LimitRequired | number |
| Account | choice |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Amount Due | number |
| Amount Paid | number |
| Amount Shipping | number |
36other output fields
List Stripe Invoices
SearchBilled Stripe invoices plus amounts due.
| Field | Type |
|---|---|
LimitRequired | number |
| Imported Invoices | choice |
| Exclude Invoice ID | text |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Amount Due | number |
| Amount Paid | number |
| Amount Shipping | number |
36other output fields
List Stripe Payment Methods
SearchCard payment methods from Stripe billing.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Account | object |
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Name | text |
| Client Identifier | text |
| Currency | text |
| Invoice Notes | text |
| Is Demo | boolean |
| Card Brand | text |
| Card Exp Month | number |
6other output fields
List Stripe Prices
SearchPrices defined in Stripe billing.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Billing Scheme | text |
| Currency | text |
| Custom Unit Amount Maximum | number |
23other output fields
List Stripe Subscriptions
SearchStripe-billed subscriptions with cancellation settings.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Application Fee Percent | number |
| Billing Cycle Anchor | text |
| Cancel At | date |
16other output fields
List Subscription Add-ons
SearchExtras on subscriptions, restricted by status.
| Field | Type |
|---|---|
LimitRequired | number |
| Status | text |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Billing Renewal Term | number |
| Subscription | object |
| UID | text |
| Created | date |
| Updated | date |
| Billing Renewal Term | number |
| Quantity | number |
| Start Date | date |
| End Date | date |
| Expiration Date | date |
| Renewal Date | date |
| New Required Quantity | number |
| Add On | object |
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| Billing Add On Type | number |
| Is Quantity Editable | boolean |
| Minimum Quantity | number |
| Monthly Rate | number |
| Annual Rate | number |
| Setup Fee | number |
| Quantity | number |
| Start Date | date |
5other output fields
List Subscriptions
SearchSubscriptions within a date window.
| Field | Type |
|---|---|
LimitRequired | number |
| Started On or After | date |
| Ends Before | date |
| Fields | text |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Billing Renewal Term | number |
| Account | object |
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Name | text |
| Client Identifier | text |
| Currency | text |
| Invoice Notes | text |
| Is Demo | boolean |
| Plan | object |
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| Description | text |
| Account Registration Mode | number |
| Is Quantity Editable | boolean |
| Minimum Quantity | number |
| Maximum People | number |
| Monthly Rate | number |
| Quantity | number |
| Start Date | date |
10other output fields
List Support Cases
SearchSupport cases filtered by text, status or assignee.
| Field | Type |
|---|---|
LimitRequired | number |
| Search | text |
| Status | choice |
| Tag | choice |
| Assigned To | choice |
| Fields | text |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Submitted Date Time | date |
| Last Activity | text |
| From Person | object |
| UID | text |
| Created | date |
| Updated | date |
| text | |
| First Name | text |
| Last Name | text |
| Password Must Change | boolean |
| Phone Mobile | text |
| Phone Work | text |
| Title | text |
| Assigned To Person Client Identifier | text |
| Subject | text |
10other output fields
List Tags
SearchTags narrowed to one kind.
| Field | Type |
|---|---|
LimitRequired | number |
| Tag Type | choice |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| System Name | text |
| System Description | text |
| Tag Color | number |
| Entity Type | number |
Add a Discount to a Subscription
ActionCoupon applied to one subscription.
| Field | Type |
|---|---|
SubscriptionRequired | choice |
Discount CouponRequired | choice |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Billing Renewal Term | number |
| Account | object |
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Name | text |
| Client Identifier | text |
| Currency | text |
| Invoice Notes | text |
| Is Demo | boolean |
| Plan | object |
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| Description | text |
| Account Registration Mode | number |
| Is Quantity Editable | boolean |
| Minimum Quantity | number |
| Maximum People | number |
| Monthly Rate | number |
| Quantity | number |
| Start Date | date |
10other output fields
Add a Drip Campaign Message
ActionNext email step of a drip sequence.
| Field | Type |
|---|---|
Drip CampaignRequired | choice |
SubjectRequired | text |
BodyRequired | text |
Delay in HoursRequired | number |
| Name | text |
| Preview Text | text |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Drip Campaign | object |
| UID | text |
| Created | date |
| Updated | date |
| Is Active | boolean |
| Trigger ID | number |
| Trigger Start Value | text |
| Trigger Stop Value | text |
| Allow Repeat Processing | boolean |
| Start Drip To Existing Members | boolean |
| Mark Existing Recipients Done | boolean |
| Message | object |
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| Subject | text |
| Preview Text | text |
| Body | text |
| Design | text |
| Count Sent | number |
| Count Delivered | number |
| Delay From Prior Day | number |
| Delay In Hours | number |
| Weight | number |
Add a Person to an Account
ActionNew account member, optionally the primary contact.
| Field | Type |
|---|---|
AccountRequired | choice |
PersonRequired | choice |
| Is Primary | boolean |
| Send Welcome Email | boolean |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Person | object |
| UID | text |
| Created | date |
| Updated | date |
| text | |
| First Name | text |
| Last Name | text |
| Password Must Change | boolean |
| Phone Mobile | text |
| Phone Work | text |
| Title | text |
| Account | object |
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Name | text |
| Client Identifier | text |
| Currency | text |
| Invoice Notes | text |
| Is Demo | boolean |
| Is Primary | boolean |
| Receive Invoices | boolean |
| Role | number |
Add a Subscription to an Account
ActionFirst plan subscription for an account.
| Field | Type |
|---|---|
AccountRequired | choice |
PlanRequired | choice |
Billing TermRequired | choice |
| Quantity | number |
| Expiration Date | date |
| Add-ons | array |
| Add-on | object |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Billing Renewal Term | number |
| Account | object |
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Name | text |
| Client Identifier | text |
| Currency | text |
| Invoice Notes | text |
| Is Demo | boolean |
| Plan | object |
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| Description | text |
| Account Registration Mode | number |
| Is Quantity Editable | boolean |
| Minimum Quantity | number |
| Maximum People | number |
| Monthly Rate | number |
| Quantity | number |
| Start Date | date |
10other output fields
Add a Support Case
ActionOpens a case for a person.
| Field | Type |
|---|---|
From PersonRequired | choice |
SubjectRequired | text |
BodyRequired | text |
| Source | choice |
| Send Auto Responder | boolean |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Submitted Date Time | date |
| Last Activity | text |
| From Person | object |
| UID | text |
| Created | date |
| Updated | date |
| text | |
| First Name | text |
| Last Name | text |
| Password Must Change | boolean |
| Phone Mobile | text |
| Phone Work | text |
| Title | text |
| Assigned To Person Client Identifier | text |
| Subject | text |
10other output fields
Add a Support Case Reply
ActionAgent answer posted on a case.
| Field | Type |
|---|---|
Support CaseRequired | choice |
CommentRequired | text |
| Agent Name | text |
| Field | Type |
|---|---|
| Result | text |
Add Add-on Usage
ActionUsage logged on a subscription add-on.
| Field | Type |
|---|---|
Subscription Add-onRequired | choice |
AmountRequired | number |
Usage DateRequired | date |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Usage Date | date |
| Invoice | object |
| UID | text |
| Created | date |
| Updated | date |
| Invoice Date | date |
| Payment Reminder Sent Date | date |
| Number | number |
| Billing Invoice Status | number |
| Amount | number |
| Amount Outstanding | number |
| Is User Generated | boolean |
| Subscription Add On | object |
| UID | text |
| Created | date |
| Updated | date |
| Billing Renewal Term | number |
| Quantity | number |
| Start Date | date |
| End Date | date |
| Expiration Date | date |
| Renewal Date | date |
| New Required Quantity | number |
| Amount | number |
| Additional Usage Data | text |
Add an Add-on to a Subscription
ActionExtra product added to a subscription.
| Field | Type |
|---|---|
SubscriptionRequired | choice |
Add-onRequired | choice |
Billing TermRequired | choice |
| Quantity | number |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Billing Renewal Term | number |
| Subscription | object |
| UID | text |
| Created | date |
| Updated | date |
| Billing Renewal Term | number |
| Quantity | number |
| Start Date | date |
| End Date | date |
| Expiration Date | date |
| Renewal Date | date |
| New Required Quantity | number |
| Add On | object |
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| Billing Add On Type | number |
| Is Quantity Editable | boolean |
| Minimum Quantity | number |
| Monthly Rate | number |
| Annual Rate | number |
| Setup Fee | number |
| Quantity | number |
| Start Date | date |
5other output fields
Add an Invoice Payment
ActionLogs a payment and can mark the invoice paid.
| Field | Type |
|---|---|
AccountRequired | choice |
InvoiceRequired | choice |
AmountRequired | number |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Transaction Date | date |
| Billing Transaction Type | number |
| Account | object |
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Name | text |
| Client Identifier | text |
| Currency | text |
| Invoice Notes | text |
| Is Demo | boolean |
| Invoice | object |
| UID | text |
| Created | date |
| Updated | date |
| Invoice Date | date |
| Payment Reminder Sent Date | date |
| Number | number |
| Billing Invoice Status | number |
| Amount | number |
| Amount Outstanding | number |
| Is User Generated | boolean |
| Amount | number |
2other output fields
Add Custom Activity
ActionCustom event shown on the activity feed.
| Field | Type |
|---|---|
TitleRequired | text |
Record TypeRequired | choice |
| Description | text |
| Activity Data | text |
| Activity Time | date |
| Field | Type |
|---|---|
| Result | text |
Archive a Broadcast
ActionMoves an email broadcast into the archive.
| Field | Type |
|---|---|
BroadcastRequired | choice |
| Field | Type |
|---|---|
| Result | text |
Cancel a Broadcast Schedule
ActionPulls a scheduled email back from sending.
| Field | Type |
|---|---|
BroadcastRequired | choice |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Send Date Time | date |
| Next Run Date Time | date |
| Campaign | object |
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| From Name | text |
| From Email | text |
| Campaign Type | number |
| Message | object |
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| Subject | text |
| Preview Text | text |
| Body | text |
| Design | text |
| Count Sent | number |
| Count Delivered | number |
| Recipient Data | text |
5other output fields
Cancel a Promotion Code
ActionSwitches off a redeemable discount code.
| Field | Type |
|---|---|
Promotion CodeRequired | choice |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Account | object |
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Name | text |
| Client Identifier | text |
| Currency | text |
| Invoice Notes | text |
| Is Demo | boolean |
| Active | boolean |
| Code | text |
8other output fields
Cancel a Stripe Subscription
ActionEnds a Stripe-billed subscription, now or at period end.
| Field | Type |
|---|---|
SubscriptionRequired | choice |
| Cancel Immediately | boolean |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Application Fee Percent | number |
| Billing Cycle Anchor | text |
| Cancel At | date |
16other output fields
Cancel an Account
ActionLogs the cancellation of an account.
| Field | Type |
|---|---|
AccountRequired | choice |
| Cancellation Reason | text |
| Comment | text |
| Field | Type |
|---|---|
| Result | text |
Cancel an Account Subscription Now
ActionImmediate subscription end for an account.
| Field | Type |
|---|---|
AccountRequired | choice |
ConfirmRequired | boolean |
| Field | Type |
|---|---|
| Result | text |
Cancel Stripe Line Item Access
ActionEnds the access a single invoice line grants.
| Field | Type |
|---|---|
Line Item IDRequired | text |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Stripe Invoice | object |
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Amount Due | number |
| Amount Paid | number |
| Amount Shipping | number |
| Attempt Count | number |
| Attempted | boolean |
| Amount | number |
| Currency | text |
10other output fields
Change a Stripe Subscription
ActionPrice swap on a Stripe-billed subscription.
| Field | Type |
|---|---|
SubscriptionRequired | choice |
ItemsRequired | array |
| Item | object |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Application Fee Percent | number |
| Billing Cycle Anchor | text |
| Cancel At | date |
16other output fields
Change a Subscription
ActionPlan or term switch for an account.
| Field | Type |
|---|---|
AccountRequired | choice |
PlanRequired | choice |
Billing TermRequired | choice |
| Quantity | number |
| Expiration Date | date |
| Start Immediately | boolean |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Billing Renewal Term | number |
| Account | object |
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Name | text |
| Client Identifier | text |
| Currency | text |
| Invoice Notes | text |
| Is Demo | boolean |
| Plan | object |
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| Description | text |
| Account Registration Mode | number |
| Is Quantity Editable | boolean |
| Minimum Quantity | number |
| Maximum People | number |
| Monthly Rate | number |
| Quantity | number |
| Start Date | date |
10other output fields
Change Stripe Invoice Status
ActionMarks a Stripe invoice paid outside Stripe, uncollectible or void.
| Field | Type |
|---|---|
InvoiceRequired | choice |
New StatusRequired | choice |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Amount Due | number |
| Amount Paid | number |
| Amount Shipping | number |
36other output fields
Create a Broadcast
ActionEmail broadcast with subject, body and recipient lists.
| Field | Type |
|---|---|
NameRequired | text |
SubjectRequired | text |
BodyRequired | text |
| From Name | text |
| From Address | text |
| Email Lists | choice |
| Preview Text | text |
| Segment IDs | array |
| Segment ID | text |
1other input field
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Send Date Time | date |
| Next Run Date Time | date |
| Campaign | object |
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| From Name | text |
| From Email | text |
| Campaign Type | number |
| Message | object |
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| Subject | text |
| Preview Text | text |
| Body | text |
| Design | text |
| Count Sent | number |
| Count Delivered | number |
| Recipient Data | text |
5other output fields
Create a Deal
ActionNew deal with optional amount, due date and owner.
| Field | Type |
|---|---|
Deal NameRequired | text |
Pipeline Stage IDRequired | text |
| Amount | number |
| Due Date | date |
| Account | choice |
| People | choice |
| Assigned To | choice |
| Custom Attributes | array |
| Attribute | object |
1other input field
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| Amount | number |
| Due Date | date |
| Assigned To Person Client Identifier | text |
| Weight | number |
6other output fields
Create a Discount Coupon
ActionCoupon with a percentage or fixed amount off.
| Field | Type |
|---|---|
CodeRequired | text |
NameRequired | text |
DurationRequired | choice |
| Percent Off | number |
| Amount Off | number |
| Maximum Redemptions | number |
| Redeem By | date |
| Active | boolean |
1other input field
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Unique Identifier | text |
| Name | text |
| Is Active | boolean |
| Amount Off | number |
| Percent Off | number |
8other output fields
Create a Drip Campaign
ActionEmail sequence started and stopped by activities.
| Field | Type |
|---|---|
NameRequired | text |
| From Name | text |
| From Address | text |
| Trigger ID | number |
| Start Value | text |
| Stop Value | text |
| Allow Repeat Processing | boolean |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Is Active | boolean |
| Campaign | object |
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| From Name | text |
| From Email | text |
| Campaign Type | number |
| Trigger ID | number |
| Trigger Start Value | text |
| Trigger Stop Value | text |
3other output fields
Create a Knowledge Base Article
ActionHelp article with title, HTML body and category.
| Field | Type |
|---|---|
TitleRequired | text |
BodyRequired | text |
| Category | choice |
| Status | choice |
| Keywords | text |
| Weight | number |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Weight | number |
| Title | text |
| Body | text |
| Support Article Status | number |
| Category | object |
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| Description | text |
| Weight | number |
1other output field
Create a Person
ActionNew person identified by an email address.
| Field | Type |
|---|---|
EmailRequired | text |
| First Name | text |
| Last Name | text |
| Mobile Phone | text |
| Work Phone | text |
| Title | text |
| Time Zone | text |
| Language | text |
3other input fields
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| text | |
| First Name | text |
| Last Name | text |
| Mailing Address | object |
| UID | text |
| Created | date |
| Updated | date |
| Address Line1 | text |
| Address Line2 | text |
| Address Line3 | text |
| City | text |
| State | text |
| Postal Code | text |
| Country | text |
| Password Must Change | boolean |
18other output fields
Create a Product
ActionProduct with prices, built on Stripe.
| Field | Type |
|---|---|
NameRequired | text |
PricesRequired | array |
| Price | object |
| Description | text |
| Account Mode | choice |
| Unit Label | text |
| Tax Code ID | text |
| Priced Per User | boolean |
| Quantity Can Be Edited | boolean |
7other input fields
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Name | text |
| Default Price ID | text |
| Description | text |
19other output fields
Create a Promotion Code
ActionRedeemable code backed by a coupon.
| Field | Type |
|---|---|
CodeRequired | text |
CouponRequired | choice |
| Maximum Redemptions | number |
| Expires At | date |
| First Time Customers Only | boolean |
| Account | choice |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Account | object |
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Name | text |
| Client Identifier | text |
| Currency | text |
| Invoice Notes | text |
| Is Demo | boolean |
| Active | boolean |
| Code | text |
8other output fields
Create a Stripe Coupon
ActionNew Stripe coupon, optionally capped by redemptions or date.
| Field | Type |
|---|---|
NameRequired | text |
Discount TypeRequired | choice |
DurationRequired | choice |
| Maximum Redemptions | number |
| Redeem By | date |
| Products | choice |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Amount Off | number |
| Currency | text |
| Duration | text |
11other output fields
Create a Stripe Invoice
ActionRaises a Stripe invoice for an account.
| Field | Type |
|---|---|
AccountRequired | choice |
Line ItemsRequired | array |
| Line Item | object |
| Description | text |
| Days Until Due | number |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Amount Due | number |
| Amount Paid | number |
| Amount Shipping | number |
36other output fields
Create a Stripe Subscription
ActionStripe-billed subscription started for an account.
| Field | Type |
|---|---|
AccountRequired | choice |
ItemsRequired | array |
| Item | object |
| Trial Period Days | number |
| Promotion Code | choice |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Application Fee Percent | number |
| Billing Cycle Anchor | text |
| Cancel At | date |
16other output fields
Create a Tag
ActionAdds a tag, or returns the existing one with that name.
| Field | Type |
|---|---|
NameRequired | text |
Tag TypeRequired | choice |
| Colour | choice |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| System Name | text |
| System Description | text |
| Tag Color | number |
| Entity Type | number |
Create an Account
ActionNew account with its primary contact and optional plan.
| Field | Type |
|---|---|
Account NameRequired | text |
Primary ContactRequired | choice |
| Plan | choice |
| Billing Term | choice |
| Mailing Address | object |
| Address Line 1 | text |
| Address Line 2 | text |
| Address Line 3 | text |
| City | text |
| State | text |
| Postal Code | text |
| Country | text |
| Billing Address | object |
| Address Line 1 | text |
| Address Line 2 | text |
| Address Line 3 | text |
| City | text |
| State | text |
| Postal Code | text |
| Country | text |
| Custom Attributes | array |
| Attribute | object |
| Send Confirmation Email | boolean |
2other input fields
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Name | text |
| Client Identifier | text |
| Currency | text |
42other output fields
Create an Email List
ActionSubscriber list with optional double opt-in and welcome email.
| Field | Type |
|---|---|
NameRequired | text |
| Description | text |
| Requires Double Opt-in | boolean |
| Welcome Email Subject | text |
| Welcome Email Body | text |
| Welcome Email From Name | text |
| Welcome Email From Address | text |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| Description | text |
| Welcome Subject | text |
| Welcome Body | text |
| Welcome From Name | text |
10other output fields
Create an Invoice
ActionInvoice for a subscription in Outseta billing.
| Field | Type |
|---|---|
SubscriptionRequired | choice |
Invoice DateRequired | date |
Line ItemsRequired | array |
| Line Item | object |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Invoice Date | date |
| Payment Reminder Sent Date | date |
| Number | number |
| Billing Invoice Status | number |
| Subscription | object |
| UID | text |
| Created | date |
| Updated | date |
| Billing Renewal Term | number |
| Quantity | number |
| Start Date | date |
| End Date | date |
| Expiration Date | date |
| Renewal Date | date |
| New Required Quantity | number |
17other output fields
Delete a Broadcast
ActionDeletes one email broadcast in Outseta.
| Field | Type |
|---|---|
BroadcastRequired | choice |
| Field | Type |
|---|---|
| Result | text |
Delete a Deal
ActionRemoves one deal from your Outseta pipeline.
| Field | Type |
|---|---|
DealRequired | choice |
| Field | Type |
|---|---|
| Result | text |
Delete a Discount Coupon
ActionDeletes the coupon in your Outseta billing setup.
| Field | Type |
|---|---|
Discount CouponRequired | choice |
| Field | Type |
|---|---|
| Result | text |
Delete a Drip Campaign
ActionRemoves the drip campaign in Outseta.
| Field | Type |
|---|---|
Drip CampaignRequired | choice |
| Field | Type |
|---|---|
| Result | text |
Delete a Drip Campaign Message
ActionDeletes one email step inside a drip campaign.
| Field | Type |
|---|---|
Drip CampaignRequired | choice |
| Field | Type |
|---|---|
| Result | text |
Delete a Person
ActionRemoves one person from Outseta CRM.
| Field | Type |
|---|---|
PersonRequired | choice |
| Field | Type |
|---|---|
| Result | text |
Delete a Stripe Coupon
ActionRemoves one Stripe coupon from billing in Outseta.
| Field | Type |
|---|---|
CouponRequired | choice |
| Field | Type |
|---|---|
| Result | text |
Delete a Support Case
ActionDeletes the support case on your Outseta site.
| Field | Type |
|---|---|
Support CaseRequired | choice |
| Field | Type |
|---|---|
| Result | text |
Delete a Tag
ActionDeletes one tag from your Outseta site.
| Field | Type |
|---|---|
TagRequired | choice |
| Field | Type |
|---|---|
| Result | text |
Delete an Account
ActionRemoves one account in Outseta.
| Field | Type |
|---|---|
AccountRequired | choice |
| Field | Type |
|---|---|
| Result | text |
Delete an Email List
ActionRemoves an email list from Outseta.
| Field | Type |
|---|---|
Email ListRequired | choice |
| Field | Type |
|---|---|
| Result | text |
Delete an Invoice
ActionDeletes a billing invoice in Outseta.
| Field | Type |
|---|---|
InvoiceRequired | choice |
| Field | Type |
|---|---|
| Result | text |
End a Subscription Add-on
ActionEnds a single add-on on a subscription and returns its dates.
| Field | Type |
|---|---|
Subscription Add-onRequired | choice |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Billing Renewal Term | number |
| Subscription | object |
| UID | text |
| Created | date |
| Updated | date |
| Billing Renewal Term | number |
| Quantity | number |
| Start Date | date |
| End Date | date |
| Expiration Date | date |
| Renewal Date | date |
| New Required Quantity | number |
| Add On | object |
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| Billing Add On Type | number |
| Is Quantity Editable | boolean |
| Minimum Quantity | number |
| Monthly Rate | number |
| Annual Rate | number |
| Setup Fee | number |
| Quantity | number |
| Start Date | date |
5other output fields
Extend a Stripe Subscription Trial
ActionTrial extension for a Stripe-billed subscription.
| Field | Type |
|---|---|
SubscriptionRequired | choice |
New DateRequired | date |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Application Fee Percent | number |
| Billing Cycle Anchor | text |
| Cancel At | date |
16other output fields
Extend an Account Trial
ActionLater end date for an account trial.
| Field | Type |
|---|---|
AccountRequired | choice |
New Trial End DateRequired | date |
| Expiration Date | date |
| Field | Type |
|---|---|
| Result | text |
Issue a Stripe Invoice Credit
ActionCredits a Stripe invoice as account balance, refund or out of band.
| Field | Type |
|---|---|
InvoiceRequired | choice |
Credit AmountRequired | number |
Credit TypeRequired | choice |
| Reason | text |
| Field | Type |
|---|---|
| Result | text |
Make an API Call
universalYour own Outseta REST API request.
| Field | Type |
|---|---|
URLRequired | text |
MethodRequired | choice |
| Headers | array |
| Header | object |
| Query String | array |
| Parameter | object |
| Body | text |
| Field | Type |
|---|---|
| Body | text |
| Headers | object |
| Status code | number |
Pause a Stripe Subscription
ActionPause with an optional restart date.
| Field | Type |
|---|---|
SubscriptionRequired | choice |
BehaviorRequired | choice |
| Resumes At | date |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Application Fee Percent | number |
| Billing Cycle Anchor | text |
| Cancel At | date |
16other output fields
Register an Account
ActionNew account signed up on a plan.
| Field | Type |
|---|---|
EmailRequired | text |
PlanRequired | choice |
Billing TermRequired | choice |
| Account Name | text |
| Billing Address | object |
| Address Line 1 | text |
| Address Line 2 | text |
| Address Line 3 | text |
| City | text |
| State | text |
| Postal Code | text |
| Country | text |
| Payment Token | secret |
| Name on Card | text |
| Card Type | text |
2other input fields
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Name | text |
| Client Identifier | text |
| Currency | text |
42other output fields
Remove a Discount from a Subscription
ActionRemoves a coupon that was applied to a subscription.
| Field | Type |
|---|---|
SubscriptionRequired | choice |
Discount CouponRequired | choice |
| Field | Type |
|---|---|
| Result | text |
Remove a Person from an Account
ActionUnlinks one person from the account they belong to.
| Field | Type |
|---|---|
AccountRequired | choice |
| Field | Type |
|---|---|
| Result | text |
Remove a Stripe Subscription Cancellation
ActionReinstates a subscription that was set to cancel.
| Field | Type |
|---|---|
SubscriptionRequired | choice |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Application Fee Percent | number |
| Billing Cycle Anchor | text |
| Cancel At | date |
16other output fields
Remove a Subscriber from an Email List
ActionDetaches a subscriber from a mailing list.
| Field | Type |
|---|---|
Email ListRequired | choice |
| Field | Type |
|---|---|
| Result | text |
Remove an Account Cancellation
ActionUndoes an account cancellation recorded earlier.
| Field | Type |
|---|---|
AccountRequired | choice |
| Field | Type |
|---|---|
| Result | text |
Resume a Stripe Subscription
ActionUn-pauses a Stripe-billed subscription.
| Field | Type |
|---|---|
SubscriptionRequired | choice |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Application Fee Percent | number |
| Billing Cycle Anchor | text |
| Cancel At | date |
16other output fields
Send a Password Reset Email
ActionPassword reset link sent to a person.
| Field | Type |
|---|---|
EmailRequired | text |
| Reset Page URL | text |
| Field | Type |
|---|---|
| Result | text |
Send a Stripe Invoice
ActionStripe invoice delivered by email.
| Field | Type |
|---|---|
InvoiceRequired | choice |
| Field | Type |
|---|---|
| Result | text |
Send an Account Confirmation Email
ActionSign-up confirmation delivered for an account.
| Field | Type |
|---|---|
AccountRequired | choice |
Send ToRequired | choice |
| Field | Type |
|---|---|
| Result | text |
Send an Email Template
ActionOne-off email from a saved template.
| Field | Type |
|---|---|
TemplateRequired | choice |
PersonRequired | choice |
| Subject | text |
| From Name | text |
| From Address | text |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Template | object |
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| Subject | text |
| Body | text |
| Design | text |
| Description | text |
| System Name | text |
| Is Internal | boolean |
| Recipient | object |
| UID | text |
| Created | date |
| Updated | date |
| text | |
| First Name | text |
| Last Name | text |
| Password Must Change | boolean |
| Phone Mobile | text |
| Phone Work | text |
| Title | text |
| Unique Message ID | text |
| Subject | text |
| From Email | text |
10other output fields
Send an Invoice Email
ActionBilling invoice mailed out from Outseta.
| Field | Type |
|---|---|
InvoiceRequired | choice |
| Note | text |
| BCC | text |
| Field | Type |
|---|---|
| Result | text |
Send an Invoice Paid Email
ActionPaid-invoice notice delivered by Outseta.
| Field | Type |
|---|---|
InvoiceRequired | choice |
| Field | Type |
|---|---|
| Result | text |
Set a Temporary Password for a Person
ActionOne-time password that forces a change at login.
| Field | Type |
|---|---|
PersonRequired | choice |
Temporary PasswordRequired | secret |
| Field | Type |
|---|---|
| Result | text |
Set an Account Renewal Date
ActionNew renewal and end dates on a subscription.
| Field | Type |
|---|---|
AccountRequired | choice |
| Renewal Date | date |
| Expiration Date | date |
| Remove Expiration Date | boolean |
| Field | Type |
|---|---|
| Result | text |
Start a Stripe Subscription
ActionBegins a Stripe-billed subscription.
| Field | Type |
|---|---|
SubscriptionRequired | choice |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Application Fee Percent | number |
| Billing Cycle Anchor | text |
| Cancel At | date |
16other output fields
Subscribe a Person to an Email List
ActionList sign-up with subscriber status and dates.
| Field | Type |
|---|---|
Email ListRequired | choice |
PersonRequired | choice |
| Send Welcome Email | boolean |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Email List Subscriber Status | number |
| Subscribed Date | date |
| Confirmed Date | date |
| Confirmation Notes | text |
| Unsubscribed Date | date |
8other output fields
Update a Broadcast
ActionScheduling and recipient changes for a broadcast.
| Field | Type |
|---|---|
BroadcastRequired | choice |
| Name | text |
| Subject | text |
| Body | text |
| From Name | text |
| From Address | text |
| Add Email Lists | choice |
| Send At | date |
4other input fields
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Send Date Time | date |
| Next Run Date Time | date |
| Campaign | object |
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| From Name | text |
| From Email | text |
| Campaign Type | number |
| Message | object |
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| Subject | text |
| Preview Text | text |
| Body | text |
| Design | text |
| Count Sent | number |
| Count Delivered | number |
| Recipient Data | text |
5other output fields
Update a Deal
ActionStage, amount and owner changes on a deal.
| Field | Type |
|---|---|
DealRequired | choice |
| Deal Name | text |
| Pipeline Stage ID | text |
| Amount | number |
| Due Date | date |
| Account | choice |
| Replace People | choice |
| Assigned To | choice |
3other input fields
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| Amount | number |
| Due Date | date |
| Assigned To Person Client Identifier | text |
| Weight | number |
6other output fields
Update a Discount Coupon
ActionCoupon terms changed in Outseta billing.
| Field | Type |
|---|---|
Discount CouponRequired | choice |
| Code | text |
| Name | text |
| Percent Off | number |
| Amount Off | number |
| Duration | choice |
| Maximum Redemptions | number |
| Redeem By | date |
3other input fields
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Unique Identifier | text |
| Name | text |
| Is Active | boolean |
| Amount Off | number |
| Percent Off | number |
8other output fields
Update a Drip Campaign
ActionDrip sequence changes, including switching it on.
| Field | Type |
|---|---|
Drip CampaignRequired | choice |
| Name | text |
| From Name | text |
| From Address | text |
| Trigger ID | number |
| Start Value | text |
| Stop Value | text |
| Allow Repeat Processing | choice |
3other input fields
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Is Active | boolean |
| Campaign | object |
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| From Name | text |
| From Email | text |
| Campaign Type | number |
| Trigger ID | number |
| Trigger Start Value | text |
| Trigger Stop Value | text |
3other output fields
Update a Drip Campaign Message
ActionEmail step edits inside a drip sequence.
| Field | Type |
|---|---|
Drip CampaignRequired | choice |
| Subject | text |
| Body | text |
| Delay in Hours | number |
| Name | text |
| Preview Text | text |
| Clear Fields | choice |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Drip Campaign | object |
| UID | text |
| Created | date |
| Updated | date |
| Is Active | boolean |
| Trigger ID | number |
| Trigger Start Value | text |
| Trigger Stop Value | text |
| Allow Repeat Processing | boolean |
| Start Drip To Existing Members | boolean |
| Mark Existing Recipients Done | boolean |
| Message | object |
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| Subject | text |
| Preview Text | text |
| Body | text |
| Design | text |
| Count Sent | number |
| Count Delivered | number |
| Delay From Prior Day | number |
| Delay In Hours | number |
| Weight | number |
Update a Person
ActionContact details of a person changed.
| Field | Type |
|---|---|
PersonRequired | choice |
| text | |
| First Name | text |
| Last Name | text |
| Mobile Phone | text |
| Work Phone | text |
| Title | text |
| Time Zone | text |
5other input fields
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| text | |
| First Name | text |
| Last Name | text |
| Mailing Address | object |
| UID | text |
| Created | date |
| Updated | date |
| Address Line1 | text |
| Address Line2 | text |
| Address Line3 | text |
| City | text |
| State | text |
| Postal Code | text |
| Country | text |
| Password Must Change | boolean |
18other output fields
Update a Product
ActionProduct settings changed in Stripe billing.
| Field | Type |
|---|---|
ProductRequired | choice |
| Name | text |
| Description | text |
| Active | choice |
| Account Mode | choice |
| Unit Label | text |
| Tax Code ID | text |
| Priced Per User | choice |
8other input fields
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Name | text |
| Default Price ID | text |
| Description | text |
19other output fields
Update a Support Case
ActionSupport case edits, including status and assignee.
| Field | Type |
|---|---|
Support CaseRequired | choice |
| Subject | text |
| Body | text |
| Status | choice |
| Assigned To | choice |
| Clear Fields | choice |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Submitted Date Time | date |
| Last Activity | text |
| From Person | object |
| UID | text |
| Created | date |
| Updated | date |
| text | |
| First Name | text |
| Last Name | text |
| Password Must Change | boolean |
| Phone Mobile | text |
| Phone Work | text |
| Title | text |
| Assigned To Person Client Identifier | text |
| Subject | text |
10other output fields
Update a Tag
ActionTag name and colour edits.
| Field | Type |
|---|---|
TagRequired | choice |
| Name | text |
| Colour | choice |
| Clear Fields | choice |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| System Name | text |
| System Description | text |
| Tag Color | number |
| Entity Type | number |
Update Account Payment Information
ActionCard token stored for an account.
| Field | Type |
|---|---|
AccountRequired | choice |
Payment TokenRequired | secret |
| Customer Token | secret |
| Name on Card | text |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Account | object |
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Name | text |
| Client Identifier | text |
| Currency | text |
| Invoice Notes | text |
| Is Demo | boolean |
| Customer Token | text |
| Last Four Digits | text |
| Latest Failure Date Time | date |
| Latest Failure Description | text |
15other output fields
Update an Account
ActionAccount name, notes and address edits.
| Field | Type |
|---|---|
AccountRequired | choice |
| Account Name | text |
| Client Identifier | text |
| Invoice Notes | text |
| Mailing Address | object |
| Address Line 1 | text |
| Address Line 2 | text |
| Address Line 3 | text |
| City | text |
| State | text |
| Postal Code | text |
| Country | text |
| Billing Address | object |
| Address Line 1 | text |
| Address Line 2 | text |
| Address Line 3 | text |
| City | text |
| State | text |
| Postal Code | text |
| Country | text |
| Custom Attributes | array |
| Attribute | object |
| Clear Fields | choice |
1other input field
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Stripe ID | text |
| Is Livemode | boolean |
| Name | text |
| Client Identifier | text |
| Currency | text |
42other output fields
Update an Account Membership
ActionPrimary contact, invoice and role settings for a member.
| Field | Type |
|---|---|
AccountRequired | choice |
| Is Primary Contact | choice |
| Receives Invoices | choice |
| Role | choice |
| Field | Type |
|---|---|
| Result | text |
Update an Email List
ActionSubscriber list edits and welcome message.
| Field | Type |
|---|---|
Email ListRequired | choice |
| Name | text |
| Description | text |
| Requires Double Opt-in | choice |
| Welcome Email Subject | text |
| Welcome Email Body | text |
| Welcome Email From Name | text |
| Welcome Email From Address | text |
1other input field
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| Description | text |
| Welcome Subject | text |
| Welcome Body | text |
| Welcome From Name | text |
10other output fields
Update an Email Template
ActionSaved template text updated.
| Field | Type |
|---|---|
TemplateRequired | choice |
| Subject | text |
| Body | text |
| Clear Fields | choice |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Name | text |
| Subject | text |
| Body | text |
| Design | text |
| Description | text |
5other output fields
Update an Invoice
ActionEdits the date and lines of an invoice.
| Field | Type |
|---|---|
InvoiceRequired | choice |
| Invoice Date | date |
| Replace Line Items | array |
| Line Item | object |
| Clear Fields | choice |
| Field | Type |
|---|---|
| UID | text |
| Created | date |
| Updated | date |
| Invoice Date | date |
| Payment Reminder Sent Date | date |
| Number | number |
| Billing Invoice Status | number |
| Subscription | object |
| UID | text |
| Created | date |
| Updated | date |
| Billing Renewal Term | number |
| Quantity | number |
| Start Date | date |
| End Date | date |
| Expiration Date | date |
| Renewal Date | date |
| New Required Quantity | number |
17other output fields
Templates
Look for Outseta templates in the WEXTL template library.
Browse templates →Other CRM integrations on WEXTL
Central Station CRM[2]German CRM for contacts, companies, deals, projects, tasks and notes.
folkCRM for relationships in a service business.
AffinityRelationship intelligence CRM for deal flow, people, and organizations.
GrippSmall business CRM for projects, quotes, invoices, contacts, and opportunity tracking.
Breakcold CRMLightweight CRM for sales teams to manage leads, pipelines, and customer relationships.
References
- WEXTL® Outseta Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for Outseta.
- WEXTL® visual workflow builder data.
Last updated: Nov 12, 2026 10:45
How we write our apps documentation
How we compile these docs: sources, the role of AI, and how we verify.






























