The Stripe integration lets you manage subscriptions, trials, coupons, and usage-based workflows directly from Recurly Engage prompts by connecting to your Stripe account.

Available on all Recurly Engage subscription plans

1Definition 2Key benefits 3Key details

Prerequisites

You must have Company or App Administrator permissions in Recurly Engage.
You must have a Stripe account with API access credentials and webhook capability.

Limitations

Users in Recurly Engage must have stripe_id or email_address traits for action targeting and webhook syncing.

Definition

The Stripe connector offers two activation methods, Stripe Connect and API key, and supports real-time and nightly data syncs plus 1-Click billing actions from prompts.

Key benefits

Flexible activation Choose Open Authorization (OAuth)-based Stripe Connect or API key authentication.

Real-time updates Sync subscription status and billing event traits through webhooks.

Comprehensive actions Upgrade, extend trials, apply coupons, and manage subscriptions without leaving prompts.

Key details

Activation

You can activate the Stripe connector using one of two methods: Stripe Connect or an API key. Stripe Connect integrates with Recurly Engage by authenticating with an existing Stripe user account. Alternatively, you can generate a new API key.

Option 1: Stripe Connect

Authenticate with Stripe

Go to Settings → Actions → Stripe and select the button shown below to authenticate through Stripe.com.

Option 2: API key

Create a restricted key

In the Stripe Dashboard, navigate to Developers → API Keys. Create a new Restricted Key and grant the permissions listed below.

Resource type	Permissions	Connect permissions
Customers	Write	None
Subscriptions	Write	None
Products	Read	None
Prices	Read	None
Coupons	Read	None
Promotion Codes	Read	None

Copy the key into Recurly Engage

Copy the generated API key into the Settings → Actions → Stripe form in Recurly Engage.

Data integration

1-Click actions

After activation, available plans and coupons sync periodically for use in prompts. Make sure each user record includes stripe_id or email_address.

Automated data sync

When you use Stripe Connect, Recurly Engage creates a webhook to sync subscription events in real time. The imported traits include:

Trait name	Values
`subscription_status`	`incomplete`, `incomplete_expired`, `trialing`, `active`, `past_due`, `canceled`, `unpaid`, `paused` or `NONE`
`delinquent`	`true`, `false` (set to `true` when a payment fails)
`current_period_start`	<Start date of current billing period>
`current_period_end`	<End date of current billing period>
`canceled_at`	<Date of cancellation>
`cancel_at_period_end`	`true`, `false`
`trial_start`	<Start date of trial>
`trial_end`	<End date of trial>
`subscription_plan`	<Name of current or most recent subscription plan>
`recurring_interval`	`day`, `week`, `month`, `year`
`coupon`	<Coupon name>
`payment_card_brand`	`<card brand>` (for example, `visa`, `mastercard`, `amex`, `unknown`)
`payment_card_country`	`<country code>` (two-character ISO)
`payment_card_expiration`	<Payment card expiration date>
`payment_card_wallet_type`	`<wallet type>` (for example, `apple_pay`, `google_pay`, etc.)

NoteYou must also perform a nightly comma-separated values (CSV) sync that maps your internal user IDs to Stripe Customer IDs.

Supported actions

Attach these 1-Click actions to prompt interactions once your data sync is active:

Action	Description	User dependencies	Additional instructions
Update existing subscription	Switch user to a different product	`stripe_id` or `email_address`	Multiple proration options are available. See the Stripe Proration Guide.