Overview
Stripe is the dominant card-payment processor with deep automation primitives – charges, subscriptions, invoicing, products, refunds, payouts. The Automize Stripe connector covers the customer lifecycle (create / look up / update), money movement (payment intents, charges, refunds), recurring billing (subscriptions, products, prices), and reporting (balance, payouts).
- Regions: Stripe is global. Connector talks to api.stripe.com – no region selector. The account's home country is set when the Stripe account was created and affects which payment methods are available.
- Plans: All Stripe accounts. Connect (platform/marketplace) accounts need an Account header which the connector passes via the connection settings.
Setting up the connection
Auth type: Bearer Token.
- Sign in to dashboard.stripe.com → Developers → API keys.
- Create a Restricted Key (recommended) or use the Secret Key. Restricted keys let you scope what the connector can touch – minimum needed: Customers (read/write), PaymentIntents (read/write), Invoices, Subscriptions, Products, Prices.
- Toggle Test mode on/off to get keys for the right environment. Test keys start with sk_test_, live keys with sk_live_.
- In Automize, open Settings → Connectors → Stripe → Add connection. Paste the secret key.
Find your credentials at https://dashboard.stripe.com/apikeys.
Rate limits
Stripe enforces 100 read + 100 write requests per second in live mode, 25/25 in test mode. The connector retries on 429 with exponential backoff (Stripe's recommended Retry-After). For bulk operations (importing 10k+ customers) batch via async + idempotency keys.
Data model
Customer is the root of most flows.
Customer ─┬─ Payment Methods (cards, bank, wallets)
├─ Subscriptions ── Invoices ── Charges / Payment Intents
├─ One-off Charges / Payment Intents
└─ Setup Intents (saving cards for later)
Product ── Prices ── Subscriptions
Most write endpoints accept an Idempotency-Key header. Use it on every
mutating call to make retries safe.Available operations
37 operations available. Click any row to jump to its detail.
| Operation | Category | What it does |
|---|---|---|
| Cancel payment intent | General | Cancel a Stripe PaymentIntent. |
| Cancel Subscription | General | Cancel a subscription |
| Capture Payment Intent | General | Capture a previously authorized payment intent |
| Confirm payment intent | General | Confirm a Stripe PaymentIntent. |
| Create charge | General | Create a Stripe charge. |
| Create checkout session | General | Create a Stripe Checkout session. |
| Create customer | General | Create a Stripe customer. |
| Create invoice | General | Create a Stripe invoice for a customer. |
| Create payment intent | General | Create a Stripe PaymentIntent for a payment flow. |
| Create price | General | Create a Stripe price for a product. |
| Create product | General | Create a Stripe product. |
| Create refund | General | Create a Stripe refund. |
| Create subscription | General | Create a Stripe subscription. |
| Delete customer | General | Delete a Stripe customer. |
| Finalize invoice | General | Finalize a Stripe draft invoice. |
| Get balance | General | Get the Stripe account balance. |
| Get customer | General | Get a Stripe customer by ID. |
| Get invoice | General | Get a Stripe invoice by ID. |
| Get payment intent | General | Get a Stripe PaymentIntent by ID. |
| Get Product | General | Get a product by ID |
| Get Subscription | General | Get subscription details |
| List charges | General | List Stripe charges. |
| List customers | General | List Stripe customers. |
| List invoices | General | List Stripe invoices. |
| List Payment Intents | General | List all payment intents |
| List payouts | General | List Stripe payouts. |
| List Prices | General | List all prices |
| List products | General | List Stripe products. |
| List Refunds | General | List all refunds |
| List subscriptions | General | List Stripe subscriptions. |
| Pay invoice | General | Pay a Stripe invoice. |
| Search customers | General | Search Stripe customers by email, name, or metadata. |
| Send Invoice | General | Send an invoice to the customer by email |
| Update customer | General | Update an existing Stripe customer. |
| Update Invoice | General | Update a draft invoice |
| Update Subscription | General | Update a subscription |
| Void invoice | General | Void a Stripe invoice. |
Operations
Cancel payment intent
Cancel a Stripe PaymentIntent.
| Parameter | Required | Type | Description |
|---|---|---|---|
Payment Intent Id payment_intent_id | Yes | text |
Tips
- Cancels a PI that hasn't yet succeeded. Once succeeded, you must refund instead.
Cancel Subscription
Cancel a subscription
| Parameter | Required | Type | Description |
|---|---|---|---|
Subscription Id subscription_id | Yes | text |
Tips
- cancel_at_period_end=true lets the customer use it until the cycle ends. Default cancels immediately.
Capture Payment Intent
Capture a previously authorized payment intent
| Parameter | Required | Type | Description |
|---|---|---|---|
Payment Intent Id payment_intent_id | Yes | text |
Confirm payment intent
Confirm a Stripe PaymentIntent.
| Parameter | Required | Type | Description |
|---|---|---|---|
Payment Intent Id payment_intent_id | Yes | text |
Tips
- Confirms a previously-created PI with a payment method. Use when the PI was created with confirm=false.
Create charge
Create a Stripe charge.
| Parameter | Required | Type | Description |
|---|---|---|---|
Amount amount | Yes | number | |
Currency currency | Yes | text | |
Customer customer | Yes | text | |
Source source | Yes | text | |
Description description | Yes | text |
Tips
- Legacy – prefer PaymentIntents for new builds. Still valid for simple one-off card charges.
Create checkout session
Create a Stripe Checkout session.
| Parameter | Required | Type | Description |
|---|---|---|---|
Line Items line_items | No | text | |
Mode mode | No | text | |
Success Url success_url | No | text | |
Cancel Url cancel_url | No | text |
Tips
- Hosted-checkout flow. Returns a url to redirect customers to.
- Set mode: payment (one-off), subscription (recurring), setup (save card for later).
Create customer
Create a Stripe customer.
| Parameter | Required | Type | Description |
|---|---|---|---|
Email email | Yes | text | |
Name name | Yes | text | |
Phone phone | Yes | text | |
Metadata metadata | Yes | textarea |
Tips
- Send email + name at minimum. Pass metadata={your_user_id: 'abc'} so you can lookup customers later.
- Always set an idempotency_key on customer creation – duplicate creates leak resources.
Errors
already_exists– Stripe doesn't dedupe on email; this only fires if you sent a customer ID that's in use.
Create invoice
Create a Stripe invoice for a customer.
| Parameter | Required | Type | Description |
|---|---|---|---|
Customer customer | Yes | text | |
Collection Method collection_method | Yes | text | |
Auto Advance auto_advance | Yes | text |
Tips
- Auto-advance=true is usually what you want – Stripe finalises and attempts to pay automatically.
Create payment intent
Create a Stripe PaymentIntent for a payment flow.
| Parameter | Required | Type | Description |
|---|---|---|---|
Amount amount | Yes | number | |
Currency currency | Yes | text | |
Customer customer | Yes | textarea | |
Payment Method Types payment_method_types | No | text | |
Description description | No | text | |
Metadata metadata | No | text |
Tips
- PaymentIntents are the modern way to charge – replaces the legacy Charges API for new builds.
- amount in smallest currency unit (cents, fen). currency 3-letter ISO.
- Set confirm=true to attempt immediately; otherwise it stays in requires_payment_method until you supply a method.
Create price
Create a Stripe price for a product.
| Parameter | Required | Type | Description |
|---|---|---|---|
Product product | No | textarea | |
Unit Amount unit_amount | No | number | |
Currency currency | Yes | text | |
Recurring recurring | No | textarea |
Tips
- product (id) + unit_amount + currency. For subscriptions, set recurring={interval:'month'}.
Create product
Create a Stripe product.
| Parameter | Required | Type | Description |
|---|---|---|---|
Name name | Yes | text | |
Description description | No | text | |
Metadata metadata | No | text |
Tips
- Products are catalog items. Prices are how you charge for them (per unit, recurring, tiered).
Create refund
Create a Stripe refund.
| Parameter | Required | Type | Description |
|---|---|---|---|
Charge charge | Yes | text | |
Amount amount | Yes | number | |
Reason reason | Yes | text |
Tips
- Refunds a Charge or PaymentIntent by ID.
- Partial refunds: pass amount (in smallest unit).
- reason: duplicate, fraudulent, or requested_by_customer.
Create subscription
Create a Stripe subscription.
| Parameter | Required | Type | Description |
|---|---|---|---|
Customer customer | Yes | text | |
Items items | Yes | text |
Tips
- customer + items[{price: 'price_id'}] are required.
- Set trial_period_days for a free trial; default_payment_method to lock the card.
Delete customer
Delete a Stripe customer.
| Parameter | Required | Type | Description |
|---|---|---|---|
Customer Id customer_id | Yes | text |
Finalize invoice
Finalize a Stripe draft invoice.
| Parameter | Required | Type | Description |
|---|---|---|---|
Invoice Id invoice_id | Yes | text |
Tips
- Moves an invoice from draft → open. After this, line items are locked.
Get balance
Get the Stripe account balance.
No input parameters.
Tips
- Returns available + pending balance per currency. Use before payouts to verify funds.
Get customer
Get a Stripe customer by ID.
| Parameter | Required | Type | Description |
|---|---|---|---|
Customer Id customer_id | Yes | text |
Tips
- Returns customer with default_source / invoice_settings.
Get invoice
Get a Stripe invoice by ID.
| Parameter | Required | Type | Description |
|---|---|---|---|
Invoice Id invoice_id | Yes | text |
Tips
- status: draft, open, paid, uncollectible, void.
Get payment intent
Get a Stripe PaymentIntent by ID.
| Parameter | Required | Type | Description |
|---|---|---|---|
Payment Intent Id payment_intent_id | Yes | text |
Tips
- Use to poll status: requires_payment_method, requires_confirmation, requires_action, processing, succeeded, canceled.
Get Product
Get a product by ID
| Parameter | Required | Type | Description |
|---|---|---|---|
Product Id product_id | Yes | text |
Get Subscription
Get subscription details
| Parameter | Required | Type | Description |
|---|---|---|---|
Subscription Id subscription_id | Yes | text |
Tips
- Returns status: incomplete, active, past_due, canceled, unpaid, trialing.
List charges
List Stripe charges.
No input parameters.
Tips
- Same paging contract as customers.
List customers
List Stripe customers.
No input parameters.
Tips
- Cursor pagination via starting_after. Filter by email for lookup.
- Use Search Customers for SQL-like queries (test mode only without paid features).
List invoices
List Stripe invoices.
No input parameters.
Tips
- Filter by customer + status for collections workflows.
List Payment Intents
List all payment intents
No input parameters.
Tips
- Filter by customer to scope; by created[gte]/created[lte] for date ranges.
List payouts
List Stripe payouts.
No input parameters.
Tips
- Payouts to the connected bank account. Filter by status: pending, paid, failed.
List Prices
List all prices
No input parameters.
Tips
- Filter by product to find all prices for a SKU.
List products
List Stripe products.
No input parameters.
Tips
- Filter by active=true to skip archived products.
List Refunds
List all refunds
No input parameters.
Tips
- Filter by charge or payment_intent.
List subscriptions
List Stripe subscriptions.
No input parameters.
Tips
- Filter by status=active to find live subs.
Pay invoice
Pay a Stripe invoice.
| Parameter | Required | Type | Description |
|---|---|---|---|
Invoice Id invoice_id | Yes | text |
Tips
- Charges the customer's default payment method for a finalized invoice. Use when auto-advance is off.
Search customers
Search Stripe customers by email, name, or metadata.
No input parameters.
Tips
- query: Stripe query syntax (e.g. email:'foo@bar.com'). Eventually consistent (~5s lag on writes).
Send Invoice
Send an invoice to the customer by email
| Parameter | Required | Type | Description |
|---|---|---|---|
Invoice Id invoice_id | Yes | text |
Update customer
Update an existing Stripe customer.
| Parameter | Required | Type | Description |
|---|---|---|---|
Customer Id customer_id | Yes | text |
Tips
- PATCH-style – only fields you send are updated. Set a field to '' to clear it.
Update Invoice
Update a draft invoice
| Parameter | Required | Type | Description |
|---|---|---|---|
Invoice Id invoice_id | Yes | text |
Update Subscription
Update a subscription
| Parameter | Required | Type | Description |
|---|---|---|---|
Subscription Id subscription_id | Yes | text |
Tips
- Use proration_behavior to control mid-cycle prorations: create_prorations, none, always_invoice.
Void invoice
Void a Stripe invoice.
| Parameter | Required | Type | Description |
|---|---|---|---|
Invoice Id invoice_id | Yes | text |
FAQ
- Test mode vs live mode – how do I switch?
- Create two separate connections, each with its respective key (sk_test_ vs sk_live_). Use process variables to switch at runtime.
- Why am I getting 429s?
- Hit the rate limit. The connector retries automatically; if you keep hitting it, batch more aggressively or spread work across time.
- How do I make calls idempotent?
- Pass an Idempotency-Key header on every mutating call. Stripe caches the response for 24 hours so retries return the same result.
- Connect (platform) accounts – how?
- Use the Account field on the connection settings to pass through the Stripe-Account header. Each connected account is a separate connection in Automize.