# Stripe

Take payments and manage billing in Stripe: payment intents, checkout sessions and payment links, customers, charges and refunds, invoices, subscriptions, products, prices and coupons.

## Connect Stripe

1. In the sidebar, open **Connections** and press **Add connection**.
2. Type `stripe` and choose **Stripe**.
3. Fill in the fields. Each one says **Required** or **Optional**.
4. Press **Test and save**. GoRunner checks the connection before it saves anything.

The sheet asks for:

- **Secret or restricted key · Required**: sk_live_…, rk_live_…, or their test-mode forms (sk_test_…, rk_test_…). Managing webhook endpoints needs Webhook Endpoints: write.

Paste a Stripe API key from the Dashboard (Developers → API keys). A restricted key (rk_…) with only the permissions the steps need is safer than the secret key (sk_…). A test-mode key works on test data only.

[Connections](https://docs.gorunner.io/build/connections) says how to sign in again, rename or delete it. In a product that embeds GoRunner, **Add connection** can be missing: then [your provider makes connections](https://docs.gorunner.io/embed/customer-connections) for you.

## Start a workflow

Add a trigger and choose **Stripe**. The trigger uses the same connection as the steps.

### On Stripe Event

Fires when Stripe sends one of the chosen events. Publishing the workflow creates a Stripe webhook endpoint for it (its signing secret is kept encrypted); unpublishing deletes it. Every delivery's Stripe-Signature is checked and an unsigned, wrongly signed or replayed one is refused; a redelivery of the same event starts no second run. The connection's key needs Webhook Endpoints: write. Test-mode keys receive test-mode events only.

- **Events · Required**: Which Stripe events start the workflow. "Any event" subscribes to every event, which Stripe advises against. Options: Any event to treasury.received_debit.created (268 options).

A later step can use its data, such as `{{trigger.api_version}}`, `{{trigger.created}}`, `{{trigger.data}}` and 3 more. See [Use data from earlier steps](https://docs.gorunner.io/build/use-data-from-earlier-steps).

## Do things in Stripe

Add a **Stripe** step, choose a **Resource**, then an **Operation**. Choose a row to see its fields.

- [Payment Intent](https://docs.gorunner.io/apps/stripe#fields-f-paymentintent): Create · Get · Get Many · Update · Confirm · Capture · Cancel · Search
- [Checkout Session](https://docs.gorunner.io/apps/stripe#fields-f-checkoutsession): Create · Get · Get Many · Expire
- [Payment Link](https://docs.gorunner.io/apps/stripe#fields-f-paymentlink): Create · Get · Get Many · Update
- [Customer](https://docs.gorunner.io/apps/stripe#fields-f-customer): Create · Delete · Get · Get Many · Search · Update
- [Customer Card](https://docs.gorunner.io/apps/stripe#fields-f-customercard): Add · Get · Remove
- [Charge](https://docs.gorunner.io/apps/stripe#fields-f-charge): Create · Get · Get Many · Update · Capture
- [Refund](https://docs.gorunner.io/apps/stripe#fields-f-refund): Create · Get · Get Many · Update · Cancel
- [Invoice](https://docs.gorunner.io/apps/stripe#fields-f-invoice): Create · Get · Get Many · Search · Update · Finalize · Send · Pay · Void · Delete
- [Invoice Item](https://docs.gorunner.io/apps/stripe#fields-f-invoiceitem): Create · Get · Get Many · Delete
- [Subscription](https://docs.gorunner.io/apps/stripe#fields-f-subscription): Create · Get · Get Many · Search · Update · Cancel · Resume
- [Product](https://docs.gorunner.io/apps/stripe#fields-f-product): Create · Get · Get Many · Search · Update · Delete
- [Price](https://docs.gorunner.io/apps/stripe#fields-f-price): Create · Get · Get Many · Search · Update
- [Coupon](https://docs.gorunner.io/apps/stripe#fields-f-coupon): Create · Get · Get Many · Update · Delete
- [Meter Event](https://docs.gorunner.io/apps/stripe#fields-f-meterevent): Create
- [Balance](https://docs.gorunner.io/apps/stripe#fields-f-balance): Get
- [Balance Transaction](https://docs.gorunner.io/apps/stripe#fields-f-balancetransaction): Get · Get Many
- [Payout](https://docs.gorunner.io/apps/stripe#fields-f-payout): Get · Get Many
- [Event](https://docs.gorunner.io/apps/stripe#fields-f-event): Get · Get Many
- [Source](https://docs.gorunner.io/apps/stripe#fields-f-source): Delete · Get

Later steps read a step’s output by its name: see [Use data from earlier steps](https://docs.gorunner.io/build/use-data-from-earlier-steps).

## Limits

- A reply from Stripe can be up to 16 MB (a file download can have its own limit). A larger one fails the step; it is never cut short.
- When Stripe says to slow down (429), the step waits as long as it asks, if the step’s time allows. Otherwise it fails and says when to try again.

Not in your list? See [When an app isn’t here](https://docs.gorunner.io/apps/when-an-app-isnt-here#q-not-in-list).

## For developers

In the API, which calls apps pieces, Stripe is `pieceId: "stripe"` with `actionId: "stripe"`, set by `resource` and an `operation_…` field, such as `operation_balance`. Its trigger is `stripetrigger` / `stripe_event`. [Get an app](https://docs.gorunner.io/api/apps/get-app) returns every field.

It can change something outside the run (`writes_external`). See [How versions and side effects work](https://docs.gorunner.io/apps#q-versions).

### Stripe › Payment Intent

### Create

- **Amount · Optional**: In the currency's smallest unit, as Stripe takes it: 1050 is 10.50 USD, 1050 is 1,050 JPY (a zero-decimal currency), 1050 is 1.050 KWD (a three-decimal currency).
- **Currency · Optional**: Three-letter ISO currency code, such as usd, eur, jpy.
- **Customer ID · Optional**: The customer the payment belongs to (cus_…).
- **Payment Method ID · Optional**: A saved payment method to charge (pm_…).
- **Description · Optional**: Shown in the Dashboard and on receipts.
- **Receipt Email · Optional**: Where Stripe sends the receipt.
- **Confirm Now · Optional**: Confirm the payment right away (needs a payment method). Off leaves it for the customer or a later Confirm.
- **Capture · Optional**: When the money is taken: at once, or held until you Capture. Options: Automatically, Automatically (asynchronous), Manually (hold, then Capture).
- **Automatic Payment Methods · Optional**: Let Stripe offer the payment methods turned on in the Dashboard.
- **Return URL · Optional**: Where the customer comes back to after a redirect (3-D Secure, bank pages). Needed when confirming.
- **Save for Later · Optional**: Save the payment method for future payments. Options: Without the customer present, With the customer present.
- **Metadata · Optional**: Key-value pairs kept on the object, such as {"order_id": "1042"}. Up to 50 keys; values are text.
- **Additional Fields · Optional**: More of Stripe's parameters for the payment intent, as JSON by their API names. The fields above win over the same names here.

### Get

- **Payment Intent ID · Required**: The payment intent (pi_…).

### Get Many

- **Customer ID · Optional**: Only this customer's payment intents.
- **Return All · Optional**: Read every payment intent, page by page (at most 2000; past that the step fails rather than stop early). Off by default.
- **Limit · Optional**: How many payment intents to return (1–2000). Default: 50. Shows when **Return All** is off.

### Update

- **Amount · Optional**: In the currency's smallest unit, as Stripe takes it: 1050 is 10.50 USD, 1050 is 1,050 JPY (a zero-decimal currency), 1050 is 1.050 KWD (a three-decimal currency).
- **Currency · Optional**: Three-letter ISO currency code, such as usd, eur, jpy.
- **Customer ID · Optional**: The customer the payment belongs to (cus_…).
- **Payment Method ID · Optional**: A saved payment method to charge (pm_…).
- **Description · Optional**: Shown in the Dashboard and on receipts.
- **Receipt Email · Optional**: Where Stripe sends the receipt.
- **Save for Later · Optional**: Save the payment method for future payments. Options: Without the customer present, With the customer present.
- **Metadata · Optional**: Key-value pairs kept on the object, such as {"order_id": "1042"}. Up to 50 keys; values are text.
- **Additional Fields · Optional**: More of Stripe's parameters for the payment intent, as JSON by their API names. The fields above win over the same names here.
- **Payment Intent ID · Required**: The payment intent (pi_…).

### Confirm

- **Payment Method ID · Optional**: A saved payment method to charge (pm_…).
- **Return URL · Optional**: Where the customer comes back to after a redirect (3-D Secure, bank pages). Needed when confirming.
- **Payment Intent ID · Required**: The payment intent (pi_…).

### Capture

- **Payment Intent ID · Required**: The payment intent (pi_…).
- **Amount to Capture · Optional**: In the currency's smallest unit, as Stripe takes it: 1050 is 10.50 USD, 1050 is 1,050 JPY (a zero-decimal currency), 1050 is 1.050 KWD (a three-decimal currency).

### Cancel

- **Payment Intent ID · Required**: The payment intent (pi_…).
- **Reason · Optional**: Why it is cancelled. Options: Duplicate, Fraudulent, Requested by customer, Abandoned.

### Search

- **Search Query · Required**: What to find, in Stripe's search syntax, such as email:'ada@example.com'.
- **Return All · Optional**: Read every payment intent, page by page (at most 2000; past that the step fails rather than stop early). Off by default.
- **Limit · Optional**: How many payment intents to return (1–2000). Default: 50. Shows when **Return All** is off.

### Stripe › Checkout Session

### Create

- **Mode · Required**: A one-time payment, a subscription, or saving a payment method. Options: Payment, Subscription, Save a payment method.
- **Line Items · Optional**: What is bought, such as [{"price": "price_123", "quantity": 2}].
- **Success URL · Optional**: Where the customer goes after paying. {CHECKOUT_SESSION_ID} in it is replaced by the session's id.
- **Cancel URL · Optional**: Where the customer goes when they leave checkout.
- **Customer ID · Optional**: An existing customer (cus_…).
- **Customer Email · Optional**: Prefills the email when no customer is given.
- **Client Reference ID · Optional**: Your own reference (an order or cart id), returned on the session.
- **Allow Promotion Codes · Optional**: Let the customer enter a promotion code.
- **Metadata · Optional**: Key-value pairs kept on the object, such as {"order_id": "1042"}. Up to 50 keys; values are text.
- **Additional Fields · Optional**: More of Stripe's parameters for the checkout session, as JSON by their API names. The fields above win over the same names here.

### Get and Expire

- **Checkout Session ID · Required**: The checkout session (cs_…).

### Get Many

- **Customer ID · Optional**: Only this customer's sessions.
- **Status · Optional**: Only sessions in this state. Options: Open, Complete, Expired.
- **Return All · Optional**: Read every checkout session, page by page (at most 2000; past that the step fails rather than stop early). Off by default.
- **Limit · Optional**: How many checkout sessions to return (1–2000). Default: 50. Shows when **Return All** is off.

### Stripe › Payment Link

### Create

- **Line Items · Required**: What the link sells, such as [{"price": "price_123", "quantity": 1}].
- **Allow Promotion Codes · Optional**: Let the customer enter a promotion code.
- **Metadata · Optional**: Key-value pairs kept on the object, such as {"order_id": "1042"}. Up to 50 keys; values are text.
- **Additional Fields · Optional**: More of Stripe's parameters for the payment link, as JSON by their API names. The fields above win over the same names here.

### Get

- **Payment Link ID · Required**: The payment link (plink_…).

### Get Many

- **Active · Optional**: Only active (on) or inactive (off) links.
- **Return All · Optional**: Read every payment link, page by page (at most 2000; past that the step fails rather than stop early). Off by default.
- **Limit · Optional**: How many payment links to return (1–2000). Default: 50. Shows when **Return All** is off.

### Update

- **Allow Promotion Codes · Optional**: Let the customer enter a promotion code.
- **Metadata · Optional**: Key-value pairs kept on the object, such as {"order_id": "1042"}. Up to 50 keys; values are text.
- **Additional Fields · Optional**: More of Stripe's parameters for the payment link, as JSON by their API names. The fields above win over the same names here.
- **Payment Link ID · Required**: The payment link (plink_…).
- **Active · Optional**: Off stops the link from taking payments.

### Stripe › Customer

### Create

- **Name · Optional**: The customer's or business's name.
- **Email · Optional**
- **Phone · Optional**
- **Description · Optional**: A note shown in the Dashboard.
- **Address · Optional**: {"line1", "line2", "city", "state", "postal_code", "country"} (country as a two-letter code).
- **Shipping · Optional**: {"name", "phone", "address": {…}}.
- **Metadata · Optional**: Key-value pairs kept on the object, such as {"order_id": "1042"}. Up to 50 keys; values are text.
- **Additional Fields · Optional**: More of Stripe's parameters for the customer, as JSON by their API names. The fields above win over the same names here.

### Delete and Get

- **Customer ID · Required**: The customer (cus_…).

### Get Many

- **Email · Optional**: Only customers with exactly this email (case-sensitive).
- **Return All · Optional**: Read every customer, page by page (at most 2000; past that the step fails rather than stop early). Off by default.
- **Limit · Optional**: How many customers to return (1–2000). Default: 50. Shows when **Return All** is off.

### Search

- **Search Query · Required**: What to find, in Stripe's search syntax, such as email:'ada@example.com'.
- **Return All · Optional**: Read every customer, page by page (at most 2000; past that the step fails rather than stop early). Off by default.
- **Limit · Optional**: How many customers to return (1–2000). Default: 50. Shows when **Return All** is off.

### Update

- **Name · Optional**: The customer's or business's name.
- **Email · Optional**
- **Phone · Optional**
- **Description · Optional**: A note shown in the Dashboard.
- **Address · Optional**: {"line1", "line2", "city", "state", "postal_code", "country"} (country as a two-letter code).
- **Shipping · Optional**: {"name", "phone", "address": {…}}.
- **Metadata · Optional**: Key-value pairs kept on the object, such as {"order_id": "1042"}. Up to 50 keys; values are text.
- **Additional Fields · Optional**: More of Stripe's parameters for the customer, as JSON by their API names. The fields above win over the same names here.
- **Customer ID · Required**: The customer (cus_…).

### Stripe › Customer Card

### Add

- **Customer ID · Required**: The customer the card belongs to.
- **Card Token · Required**: A card token made by Stripe.js or Elements (tok_…). Card numbers are never typed here.

### Get

- **Customer ID · Required**: The customer the card belongs to.
- **Card ID · Required**: The card (card_…).

### Remove

- **Customer ID · Required**: The customer the card belongs to.
- **Card ID · Required**: The card to remove (card_…).

### Stripe › Charge

### Create

- **Customer ID · Required**: The customer to charge (cus_…).
- **Amount · Required**: In the currency's smallest unit, as Stripe takes it: 1050 is 10.50 USD, 1050 is 1,050 JPY (a zero-decimal currency), 1050 is 1.050 KWD (a three-decimal currency).
- **Currency · Required**: Three-letter ISO currency code, such as usd, eur, jpy.
- **Source ID · Required**: The customer's card or source to charge (card_…, src_…).
- **Description · Optional**
- **Receipt Email · Optional**
- **Capture Now · Optional**: Off places a hold to Capture later (within 7 days for most cards).
- **Shipping · Optional**: {"name", "address": {…}, "carrier", "tracking_number"}.
- **Metadata · Optional**: Key-value pairs kept on the object, such as {"order_id": "1042"}. Up to 50 keys; values are text.

### Get

- **Charge ID · Required**: The charge (ch_… or py_…).

### Get Many

- **Customer ID · Optional**: Only this customer's charges.
- **Return All · Optional**: Read every charge, page by page (at most 2000; past that the step fails rather than stop early). Off by default.
- **Limit · Optional**: How many charges to return (1–2000). Default: 50. Shows when **Return All** is off.

### Update

- **Description · Optional**
- **Receipt Email · Optional**
- **Shipping · Optional**: {"name", "address": {…}, "carrier", "tracking_number"}.
- **Metadata · Optional**: Key-value pairs kept on the object, such as {"order_id": "1042"}. Up to 50 keys; values are text.
- **Charge ID · Required**: The charge (ch_… or py_…).

### Capture

- **Charge ID · Required**: The charge (ch_… or py_…).
- **Amount to Capture · Optional**: In the currency's smallest unit, as Stripe takes it: 1050 is 10.50 USD, 1050 is 1,050 JPY (a zero-decimal currency), 1050 is 1.050 KWD (a three-decimal currency).

### Stripe › Refund

### Create

- **Payment Intent ID · Optional**: The payment to refund (pi_…). Set this or Charge ID.
- **Charge ID · Optional**: The charge to refund (ch_…). Set this or Payment Intent ID.
- **Amount · Optional**: Empty refunds the whole amount. In the currency's smallest unit, as Stripe takes it: 1050 is 10.50 USD, 1050 is 1,050 JPY (a zero-decimal currency), 1050 is 1.050 KWD (a three-decimal currency).
- **Reason · Optional**: Why it is refunded. Options: Duplicate, Fraudulent, Requested by customer.
- **Metadata · Optional**: Key-value pairs kept on the object, such as {"order_id": "1042"}. Up to 50 keys; values are text.

### Get and Cancel

- **Refund ID · Required**: The refund (re_…).

### Get Many

- **Charge ID · Optional**: Only refunds of this charge.
- **Payment Intent ID · Optional**: Only refunds of this payment intent.
- **Return All · Optional**: Read every refund, page by page (at most 2000; past that the step fails rather than stop early). Off by default.
- **Limit · Optional**: How many refunds to return (1–2000). Default: 50. Shows when **Return All** is off.

### Update

- **Metadata · Optional**: Key-value pairs kept on the object, such as {"order_id": "1042"}. Up to 50 keys; values are text.
- **Refund ID · Required**: The refund (re_…).

### Stripe › Invoice

### Create

- **Customer ID · Required**: Who is invoiced (cus_…).
- **Collection · Optional**: Charge the customer's saved payment method, or email the invoice for them to pay. Options: Charge automatically, Email the invoice.
- **Days Until Due · Optional**: For an emailed invoice: days the customer has to pay.
- **Due Date · Optional**: For an emailed invoice: when it is due. A date, a date-time (RFC 3339) or Unix seconds.
- **Description · Optional**: The invoice's memo.
- **Currency · Optional**: Three-letter ISO currency code, such as usd, eur, jpy.
- **Auto Advance · Optional**: Let Stripe finalize, send and collect the invoice by itself.
- **Metadata · Optional**: Key-value pairs kept on the object, such as {"order_id": "1042"}. Up to 50 keys; values are text.
- **Additional Fields · Optional**: More of Stripe's parameters for the invoice, as JSON by their API names. The fields above win over the same names here.

### Get, Send, Void and Delete

- **Invoice ID · Required**: The invoice (in_…).

### Get Many

- **Customer ID · Optional**: Only this customer's invoices.
- **Status · Optional**: Only invoices in this state. Options: Draft, Open, Paid, Uncollectible, Void.
- **Subscription ID · Optional**: Only this subscription's invoices.
- **Return All · Optional**: Read every invoice, page by page (at most 2000; past that the step fails rather than stop early). Off by default.
- **Limit · Optional**: How many invoices to return (1–2000). Default: 50. Shows when **Return All** is off.

### Search

- **Search Query · Required**: What to find, in Stripe's search syntax, such as email:'ada@example.com'.
- **Return All · Optional**: Read every invoice, page by page (at most 2000; past that the step fails rather than stop early). Off by default.
- **Limit · Optional**: How many invoices to return (1–2000). Default: 50. Shows when **Return All** is off.

### Update

- **Collection · Optional**: Charge the customer's saved payment method, or email the invoice for them to pay. Options: Charge automatically, Email the invoice.
- **Days Until Due · Optional**: For an emailed invoice: days the customer has to pay.
- **Due Date · Optional**: For an emailed invoice: when it is due. A date, a date-time (RFC 3339) or Unix seconds.
- **Description · Optional**: The invoice's memo.
- **Auto Advance · Optional**: Let Stripe finalize, send and collect the invoice by itself.
- **Metadata · Optional**: Key-value pairs kept on the object, such as {"order_id": "1042"}. Up to 50 keys; values are text.
- **Additional Fields · Optional**: More of Stripe's parameters for the invoice, as JSON by their API names. The fields above win over the same names here.
- **Invoice ID · Required**: The invoice (in_…).

### Finalize

- **Auto Advance · Optional**: Let Stripe finalize, send and collect the invoice by itself.
- **Invoice ID · Required**: The invoice (in_…).

### Pay

- **Invoice ID · Required**: The invoice (in_…).
- **Paid Outside Stripe · Optional**: Mark it paid without charging (paid by cheque, bank transfer…).

### Stripe › Invoice Item

### Create

- **Customer ID · Required**: Who is charged (cus_…).
- **Invoice ID · Optional**: A draft invoice to add it to. Empty adds it to the customer's next invoice.
- **Amount · Optional**: In the currency's smallest unit, as Stripe takes it: 1050 is 10.50 USD, 1050 is 1,050 JPY (a zero-decimal currency), 1050 is 1.050 KWD (a three-decimal currency).
- **Currency · Optional**: Three-letter ISO currency code, such as usd, eur, jpy.
- **Price ID · Optional**: A price to bill instead of an amount (price_…).
- **Quantity · Optional**: With a price: how many.
- **Description · Optional**
- **Metadata · Optional**: Key-value pairs kept on the object, such as {"order_id": "1042"}. Up to 50 keys; values are text.

### Get and Delete

- **Invoice Item ID · Required**: The invoice item (ii_…).

### Get Many

- **Customer ID · Optional**: Only this customer's items.
- **Invoice ID · Optional**: Only the items on this invoice.
- **Return All · Optional**: Read every invoice item, page by page (at most 2000; past that the step fails rather than stop early). Off by default.
- **Limit · Optional**: How many invoice items to return (1–2000). Default: 50. Shows when **Return All** is off.

### Stripe › Subscription

### Create

- **Customer ID · Required**: Who subscribes (cus_…).
- **Items · Optional**: The prices subscribed to, such as [{"price": "price_123", "quantity": 1}].
- **Default Payment Method · Optional**: The payment method to charge (pm_…).
- **Collection · Optional**: Charge automatically, or email each invoice. Options: Charge automatically, Email the invoice.
- **Days Until Due · Optional**: For emailed invoices: days to pay.
- **Trial Days · Optional**: Days of free trial before the first charge.
- **When Payment Fails · Optional**: What happens when the first payment needs the customer or fails. Options: Create it incomplete, Create it incomplete and wait for payment, Refuse, Keep the change pending.
- **Cancel at Period End · Optional**: End the subscription when the current period ends.
- **Metadata · Optional**: Key-value pairs kept on the object, such as {"order_id": "1042"}. Up to 50 keys; values are text.
- **Additional Fields · Optional**: More of Stripe's parameters for the subscription, as JSON by their API names. The fields above win over the same names here.

### Get

- **Subscription ID · Required**: The subscription (sub_…).

### Get Many

- **Customer ID · Optional**: Only this customer's subscriptions.
- **Price ID · Optional**: Only subscriptions to this price.
- **Status · Optional**: Only subscriptions in this state. Empty lists every one that is not cancelled. Options: Active, Past due, Unpaid, Cancelled, Incomplete, Incomplete, expired, Trialing, Paused, Ended, All (cancelled too).
- **Return All · Optional**: Read every subscription, page by page (at most 2000; past that the step fails rather than stop early). Off by default.
- **Limit · Optional**: How many subscriptions to return (1–2000). Default: 50. Shows when **Return All** is off.

### Search

- **Search Query · Required**: What to find, in Stripe's search syntax, such as email:'ada@example.com'.
- **Return All · Optional**: Read every subscription, page by page (at most 2000; past that the step fails rather than stop early). Off by default.
- **Limit · Optional**: How many subscriptions to return (1–2000). Default: 50. Shows when **Return All** is off.

### Update

- **Items · Optional**: The prices subscribed to, such as [{"price": "price_123", "quantity": 1}].
- **Default Payment Method · Optional**: The payment method to charge (pm_…).
- **Collection · Optional**: Charge automatically, or email each invoice. Options: Charge automatically, Email the invoice.
- **Days Until Due · Optional**: For emailed invoices: days to pay.
- **When Payment Fails · Optional**: What happens when the first payment needs the customer or fails. Options: Create it incomplete, Create it incomplete and wait for payment, Refuse, Keep the change pending.
- **Cancel at Period End · Optional**: End the subscription when the current period ends.
- **Metadata · Optional**: Key-value pairs kept on the object, such as {"order_id": "1042"}. Up to 50 keys; values are text.
- **Additional Fields · Optional**: More of Stripe's parameters for the subscription, as JSON by their API names. The fields above win over the same names here.
- **Subscription ID · Required**: The subscription (sub_…).
- **Proration · Optional**: How a change mid-period is billed. Options: Prorate on the next invoice, Prorate and invoice now, No proration.

### Cancel

- **Subscription ID · Required**: The subscription (sub_…).
- **Invoice Now · Optional**: Bill outstanding usage and prorations on a final invoice now.
- **Prorate · Optional**: Credit the unused part of the period.

### Resume

- **Subscription ID · Required**: The subscription (sub_…).
- **Proration · Optional**: How a change mid-period is billed. Options: Prorate on the next invoice, Prorate and invoice now, No proration.

### Stripe › Product

### Create

- **Name · Optional**: Shown to customers.
- **Description · Optional**
- **Active · Optional**: Off hides it from new purchases.
- **Images · Optional**: Up to 8 image URLs, separated by commas.
- **URL · Optional**: The product's public page.
- **Metadata · Optional**: Key-value pairs kept on the object, such as {"order_id": "1042"}. Up to 50 keys; values are text.
- **Additional Fields · Optional**: More of Stripe's parameters for the product, as JSON by their API names. The fields above win over the same names here.

### Get and Delete

- **Product ID · Required**: The product (prod_…, or your own id).

### Get Many

- **Active · Optional**: Only active (on) or archived (off) products.
- **Return All · Optional**: Read every product, page by page (at most 2000; past that the step fails rather than stop early). Off by default.
- **Limit · Optional**: How many products to return (1–2000). Default: 50. Shows when **Return All** is off.

### Search

- **Search Query · Required**: What to find, in Stripe's search syntax, such as email:'ada@example.com'.
- **Return All · Optional**: Read every product, page by page (at most 2000; past that the step fails rather than stop early). Off by default.
- **Limit · Optional**: How many products to return (1–2000). Default: 50. Shows when **Return All** is off.

### Update

- **Name · Optional**: Shown to customers.
- **Description · Optional**
- **Active · Optional**: Off hides it from new purchases.
- **Images · Optional**: Up to 8 image URLs, separated by commas.
- **URL · Optional**: The product's public page.
- **Metadata · Optional**: Key-value pairs kept on the object, such as {"order_id": "1042"}. Up to 50 keys; values are text.
- **Additional Fields · Optional**: More of Stripe's parameters for the product, as JSON by their API names. The fields above win over the same names here.
- **Product ID · Required**: The product (prod_…, or your own id).

### Stripe › Price

### Create

- **Product ID · Required**: The product this price is for (prod_…).
- **Currency · Required**: Three-letter ISO currency code, such as usd, eur, jpy.
- **Unit Amount · Optional**: What one unit costs. In the currency's smallest unit, as Stripe takes it: 1050 is 10.50 USD, 1050 is 1,050 JPY (a zero-decimal currency), 1050 is 1.050 KWD (a three-decimal currency).
- **Billing Interval · Optional**: Empty makes a one-time price. Options: Daily, Weekly, Monthly, Yearly.
- **Every · Optional**: Bill every N intervals (3 with Monthly = quarterly).
- **Nickname · Optional**: A name only you see.
- **Lookup Key · Optional**: Your own key to find the price by.
- **Tax Behavior · Optional**: Whether the amount includes tax. Options: Tax on top, Tax included, Unspecified.
- **Metadata · Optional**: Key-value pairs kept on the object, such as {"order_id": "1042"}. Up to 50 keys; values are text.
- **Additional Fields · Optional**: More of Stripe's parameters for the price, as JSON by their API names. The fields above win over the same names here.

### Get

- **Price ID · Required**: The price (price_…).

### Get Many

- **Product ID · Optional**: Only this product's prices.
- **Active · Optional**: Only active (on) or inactive (off) prices.
- **Type · Optional**: Only one-time or recurring prices. Options: One-time, Recurring.
- **Return All · Optional**: Read every price, page by page (at most 2000; past that the step fails rather than stop early). Off by default.
- **Limit · Optional**: How many prices to return (1–2000). Default: 50. Shows when **Return All** is off.

### Search

- **Search Query · Required**: What to find, in Stripe's search syntax, such as email:'ada@example.com'.
- **Return All · Optional**: Read every price, page by page (at most 2000; past that the step fails rather than stop early). Off by default.
- **Limit · Optional**: How many prices to return (1–2000). Default: 50. Shows when **Return All** is off.

### Update

- **Nickname · Optional**: A name only you see.
- **Lookup Key · Optional**: Your own key to find the price by.
- **Tax Behavior · Optional**: Whether the amount includes tax. Options: Tax on top, Tax included, Unspecified.
- **Metadata · Optional**: Key-value pairs kept on the object, such as {"order_id": "1042"}. Up to 50 keys; values are text.
- **Price ID · Required**: The price (price_…).
- **Active · Optional**: Off stops new purchases at this price.

### Stripe › Coupon

### Create

- **Duration · Required**: How long the discount applies once a customer has it. Options: Forever, Once, For some months.
- **Discount Type · Required**: A percentage, or a fixed amount off. Options: Percentage, Fixed amount. Default: Percentage.
- **Amount Off · Optional**: For a fixed-amount coupon. In the currency's smallest unit, as Stripe takes it: 1050 is 10.50 USD, 1050 is 1,050 JPY (a zero-decimal currency), 1050 is 1.050 KWD (a three-decimal currency).
- **Currency · Optional**: Three-letter ISO currency code, such as usd, eur, jpy.
- **Percent Off · Optional**: For a percentage coupon: more than 0, at most 100 (such as 12.5).
- **Duration in Months · Optional**: For a coupon that applies for some months.
- **Name · Optional**: Shown to customers on invoices and receipts.
- **Coupon ID · Optional**: Your own id for the coupon. Empty lets Stripe make one.
- **Max Redemptions · Optional**: How many times it can be used in all.
- **Redeem By · Optional**: The last moment it can be used. A date, a date-time (RFC 3339) or Unix seconds.
- **Metadata · Optional**: Key-value pairs kept on the object, such as {"order_id": "1042"}. Up to 50 keys; values are text.

### Get and Delete

- **Coupon ID · Required**: The coupon's id.

### Get Many

- **Return All · Optional**: Read every coupon, page by page (at most 2000; past that the step fails rather than stop early). Off by default.
- **Limit · Optional**: How many coupons to return (1–2000). Default: 50. Shows when **Return All** is off.

### Update

- **Name · Optional**: Shown to customers on invoices and receipts.
- **Metadata · Optional**: Key-value pairs kept on the object, such as {"order_id": "1042"}. Up to 50 keys; values are text.
- **Coupon ID · Required**: The coupon's id.

### Stripe › Meter Event

### Create

- **Event Name · Required**: The meter's event name, as set on the meter.
- **Customer ID · Required**: Whose usage it is (cus_…).
- **Value · Required**: How much usage (a whole number).
- **Identifier · Optional**: A unique id for this event, so a repeat is not counted twice. Empty lets Stripe make one.
- **Timestamp · Optional**: When the usage happened (within the past 35 days). Empty is now. A date, a date-time (RFC 3339) or Unix seconds.

### Stripe › Balance

### Get

Nothing to fill in.

### Stripe › Balance Transaction

### Get

- **Balance Transaction ID · Required**: The balance transaction (txn_…).

### Get Many

- **Type · Optional**: Only this type: charge, refund, payout, stripe_fee, adjustment, ….
- **Payout ID · Optional**: Only the transactions paid out in this payout (po_…).
- **Return All · Optional**: Read every balance transaction, page by page (at most 2000; past that the step fails rather than stop early). Off by default.
- **Limit · Optional**: How many balance transactions to return (1–2000). Default: 50. Shows when **Return All** is off.

### Stripe › Payout

### Get

- **Payout ID · Required**: The payout (po_…).

### Get Many

- **Status · Optional**: Only payouts in this state. Options: Pending, Paid, Failed, Cancelled.
- **Return All · Optional**: Read every payout, page by page (at most 2000; past that the step fails rather than stop early). Off by default.
- **Limit · Optional**: How many payouts to return (1–2000). Default: 50. Shows when **Return All** is off.

### Stripe › Event

### Get

- **Event ID · Required**: The event (evt_…).

### Get Many

- **Type · Optional**: Only events of this type, such as invoice.paid (* at the end matches a prefix: invoice.*).
- **Return All · Optional**: Read every event, page by page (at most 2000; past that the step fails rather than stop early). Off by default.
- **Limit · Optional**: How many events to return (1–2000). Default: 50. Shows when **Return All** is off.

### Stripe › Source

### Delete

- **Customer ID · Required**: The customer the source is attached to.
- **Source ID · Required**: The source (src_…).

### Get

- **Source ID · Required**: The source (src_…).

Source: https://docs.gorunner.io/apps/stripe