# Stripe (/integrations/stripe)
{/* MANUAL-CONTENT-START:intro */}
Use [Stripe](https://stripe.com/) in Sim to manage payment intents, customers, subscriptions, invoices, charges, products, and prices. Stripe event triggers can start workflows when payment or other supported events occur.
{/* MANUAL-CONTENT-END */}
## Use the block [#usage-instructions]
Manage payment intents, customers, subscriptions, invoices, charges, products, prices, and events. Supported Stripe events can start workflows.
## Actions [#actions]
### Stripe Create Payment Intent [#stripe-create-payment-intent]
Create a new Payment Intent to process a payment
#### Input [#input]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `amount` | number | Yes | Amount in the currency’s smallest unit (e.g., 2000 for 20.00 USD) |
| `currency` | string | Yes | Three-letter ISO currency code (e.g., usd, eur) |
| `customer` | string | No | Customer ID to associate with this payment |
| `payment_method` | string | No | Payment method ID |
| `description` | string | No | Description of the payment |
| `receipt_email` | string | No | Email address to send receipt to |
| `metadata` | json | No | Set of key-value pairs for storing additional information |
| `automatic_payment_methods` | json | No | Enable automatic payment methods (e.g., \{"enabled": true}) |
#### Output [#output]
| Parameter | Type | Description |
| - | - | - |
| `payment_intent` | object | Stripe Payment Intent object |
| ↳ `id` | string | Unique identifier for the Payment Intent |
| ↳ `object` | string | String representing the object type (payment\_intent) |
| ↳ `amount` | number | Amount intended to be collected in smallest currency unit |
| ↳ `amount_capturable` | number | Amount that can be captured |
| ↳ `amount_received` | number | Amount that was collected |
| ↳ `application` | string | ID of the Connect application that created the PaymentIntent |
| ↳ `application_fee_amount` | number | Application fee amount (if any) |
| ↳ `automatic_payment_methods` | json | Settings for automatic payment methods |
| ↳ `canceled_at` | number | Unix timestamp of cancellation |
| ↳ `cancellation_reason` | string | Reason for cancellation |
| ↳ `capture_method` | string | Controls when funds will be captured (automatic or manual) |
| ↳ `client_secret` | string | Client secret for confirming the PaymentIntent |
| ↳ `confirmation_method` | string | How the PaymentIntent can be confirmed (automatic or manual) |
| ↳ `created` | number | Unix timestamp when the PaymentIntent was created |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
| ↳ `customer` | string | ID of the Customer this PaymentIntent belongs to |
| ↳ `description` | string | Description of the payment |
| ↳ `invoice` | string | ID of the invoice that created this PaymentIntent |
| ↳ `last_payment_error` | json | The payment error encountered in the previous PaymentIntent confirmation |
| ↳ `latest_charge` | string | ID of the latest charge created by this PaymentIntent |
| ↳ `livemode` | boolean | Whether object exists in live mode or test mode |
| ↳ `metadata` | json | Set of key-value pairs for storing additional information |
| ↳ `next_action` | json | Actions required before the PaymentIntent can be confirmed |
| ↳ `on_behalf_of` | string | The account on behalf of which to charge |
| ↳ `payment_method` | string | ID of the payment method used |
| ↳ `payment_method_options` | json | Payment-method-specific configuration |
| ↳ `payment_method_types` | array | Payment method types that can be used |
| ↳ `processing` | json | Processing status if payment is being processed asynchronously |
| ↳ `receipt_email` | string | Email address to send the receipt to |
| ↳ `review` | string | ID of the review associated with this PaymentIntent |
| ↳ `setup_future_usage` | string | Indicates intent to make future payments |
| ↳ `shipping` | object | Shipping information |
| ↳ `name` | string | Recipient name |
| ↳ `phone` | string | Recipient phone number |
| ↳ `address` | object | Address object |
| ↳ `line1` | string | Address line 1 (street address) |
| ↳ `line2` | string | Address line 2 (apartment, suite, etc.) |
| ↳ `city` | string | City name |
| ↳ `state` | string | State, county, province, or region |
| ↳ `postal_code` | string | ZIP or postal code |
| ↳ `country` | string | Two-letter country code (ISO 3166-1 alpha-2) |
| ↳ `statement_descriptor` | string | Statement descriptor for charges |
| ↳ `statement_descriptor_suffix` | string | Statement descriptor suffix |
| ↳ `status` | string | Status of the PaymentIntent (requires\_payment\_method, requires\_confirmation, requires\_action, processing, requires\_capture, canceled, succeeded) |
| ↳ `transfer_data` | json | The data for creating a transfer after the payment succeeds |
| ↳ `transfer_group` | string | Transfer group for transfers associated with the payment |
| `metadata` | json | Payment Intent metadata including ID, status, amount, and currency |
| ↳ `id` | string | Stripe unique identifier |
| ↳ `status` | string | Current state of the resource |
| ↳ `amount` | number | Amount in smallest currency unit (e.g., cents) |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
### Stripe Retrieve Payment Intent [#stripe-retrieve-payment-intent]
Retrieve an existing Payment Intent by ID
#### Input [#input-1]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `id` | string | Yes | Payment Intent ID (e.g., pi\_1234567890) |
#### Output [#output-1]
| Parameter | Type | Description |
| - | - | - |
| `payment_intent` | object | Stripe Payment Intent object |
| ↳ `id` | string | Unique identifier for the Payment Intent |
| ↳ `object` | string | String representing the object type (payment\_intent) |
| ↳ `amount` | number | Amount intended to be collected in smallest currency unit |
| ↳ `amount_capturable` | number | Amount that can be captured |
| ↳ `amount_received` | number | Amount that was collected |
| ↳ `application` | string | ID of the Connect application that created the PaymentIntent |
| ↳ `application_fee_amount` | number | Application fee amount (if any) |
| ↳ `automatic_payment_methods` | json | Settings for automatic payment methods |
| ↳ `canceled_at` | number | Unix timestamp of cancellation |
| ↳ `cancellation_reason` | string | Reason for cancellation |
| ↳ `capture_method` | string | Controls when funds will be captured (automatic or manual) |
| ↳ `client_secret` | string | Client secret for confirming the PaymentIntent |
| ↳ `confirmation_method` | string | How the PaymentIntent can be confirmed (automatic or manual) |
| ↳ `created` | number | Unix timestamp when the PaymentIntent was created |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
| ↳ `customer` | string | ID of the Customer this PaymentIntent belongs to |
| ↳ `description` | string | Description of the payment |
| ↳ `invoice` | string | ID of the invoice that created this PaymentIntent |
| ↳ `last_payment_error` | json | The payment error encountered in the previous PaymentIntent confirmation |
| ↳ `latest_charge` | string | ID of the latest charge created by this PaymentIntent |
| ↳ `livemode` | boolean | Whether object exists in live mode or test mode |
| ↳ `metadata` | json | Set of key-value pairs for storing additional information |
| ↳ `next_action` | json | Actions required before the PaymentIntent can be confirmed |
| ↳ `on_behalf_of` | string | The account on behalf of which to charge |
| ↳ `payment_method` | string | ID of the payment method used |
| ↳ `payment_method_options` | json | Payment-method-specific configuration |
| ↳ `payment_method_types` | array | Payment method types that can be used |
| ↳ `processing` | json | Processing status if payment is being processed asynchronously |
| ↳ `receipt_email` | string | Email address to send the receipt to |
| ↳ `review` | string | ID of the review associated with this PaymentIntent |
| ↳ `setup_future_usage` | string | Indicates intent to make future payments |
| ↳ `shipping` | object | Shipping information |
| ↳ `name` | string | Recipient name |
| ↳ `phone` | string | Recipient phone number |
| ↳ `address` | object | Address object |
| ↳ `line1` | string | Address line 1 (street address) |
| ↳ `line2` | string | Address line 2 (apartment, suite, etc.) |
| ↳ `city` | string | City name |
| ↳ `state` | string | State, county, province, or region |
| ↳ `postal_code` | string | ZIP or postal code |
| ↳ `country` | string | Two-letter country code (ISO 3166-1 alpha-2) |
| ↳ `statement_descriptor` | string | Statement descriptor for charges |
| ↳ `statement_descriptor_suffix` | string | Statement descriptor suffix |
| ↳ `status` | string | Status of the PaymentIntent (requires\_payment\_method, requires\_confirmation, requires\_action, processing, requires\_capture, canceled, succeeded) |
| ↳ `transfer_data` | json | The data for creating a transfer after the payment succeeds |
| ↳ `transfer_group` | string | Transfer group for transfers associated with the payment |
| `metadata` | json | Payment Intent metadata including ID, status, amount, and currency |
| ↳ `id` | string | Stripe unique identifier |
| ↳ `status` | string | Current state of the resource |
| ↳ `amount` | number | Amount in smallest currency unit (e.g., cents) |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
### Stripe Update Payment Intent [#stripe-update-payment-intent]
Update an existing Payment Intent
#### Input [#input-2]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `id` | string | Yes | Payment Intent ID (e.g., pi\_1234567890) |
| `amount` | number | No | Updated amount in the currency’s smallest unit |
| `currency` | string | No | Three-letter ISO currency code |
| `customer` | string | No | Customer ID |
| `description` | string | No | Updated description |
| `metadata` | json | No | Updated metadata |
#### Output [#output-2]
| Parameter | Type | Description |
| - | - | - |
| `payment_intent` | object | Stripe Payment Intent object |
| ↳ `id` | string | Unique identifier for the Payment Intent |
| ↳ `object` | string | String representing the object type (payment\_intent) |
| ↳ `amount` | number | Amount intended to be collected in smallest currency unit |
| ↳ `amount_capturable` | number | Amount that can be captured |
| ↳ `amount_received` | number | Amount that was collected |
| ↳ `application` | string | ID of the Connect application that created the PaymentIntent |
| ↳ `application_fee_amount` | number | Application fee amount (if any) |
| ↳ `automatic_payment_methods` | json | Settings for automatic payment methods |
| ↳ `canceled_at` | number | Unix timestamp of cancellation |
| ↳ `cancellation_reason` | string | Reason for cancellation |
| ↳ `capture_method` | string | Controls when funds will be captured (automatic or manual) |
| ↳ `client_secret` | string | Client secret for confirming the PaymentIntent |
| ↳ `confirmation_method` | string | How the PaymentIntent can be confirmed (automatic or manual) |
| ↳ `created` | number | Unix timestamp when the PaymentIntent was created |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
| ↳ `customer` | string | ID of the Customer this PaymentIntent belongs to |
| ↳ `description` | string | Description of the payment |
| ↳ `invoice` | string | ID of the invoice that created this PaymentIntent |
| ↳ `last_payment_error` | json | The payment error encountered in the previous PaymentIntent confirmation |
| ↳ `latest_charge` | string | ID of the latest charge created by this PaymentIntent |
| ↳ `livemode` | boolean | Whether object exists in live mode or test mode |
| ↳ `metadata` | json | Set of key-value pairs for storing additional information |
| ↳ `next_action` | json | Actions required before the PaymentIntent can be confirmed |
| ↳ `on_behalf_of` | string | The account on behalf of which to charge |
| ↳ `payment_method` | string | ID of the payment method used |
| ↳ `payment_method_options` | json | Payment-method-specific configuration |
| ↳ `payment_method_types` | array | Payment method types that can be used |
| ↳ `processing` | json | Processing status if payment is being processed asynchronously |
| ↳ `receipt_email` | string | Email address to send the receipt to |
| ↳ `review` | string | ID of the review associated with this PaymentIntent |
| ↳ `setup_future_usage` | string | Indicates intent to make future payments |
| ↳ `shipping` | object | Shipping information |
| ↳ `name` | string | Recipient name |
| ↳ `phone` | string | Recipient phone number |
| ↳ `address` | object | Address object |
| ↳ `line1` | string | Address line 1 (street address) |
| ↳ `line2` | string | Address line 2 (apartment, suite, etc.) |
| ↳ `city` | string | City name |
| ↳ `state` | string | State, county, province, or region |
| ↳ `postal_code` | string | ZIP or postal code |
| ↳ `country` | string | Two-letter country code (ISO 3166-1 alpha-2) |
| ↳ `statement_descriptor` | string | Statement descriptor for charges |
| ↳ `statement_descriptor_suffix` | string | Statement descriptor suffix |
| ↳ `status` | string | Status of the PaymentIntent (requires\_payment\_method, requires\_confirmation, requires\_action, processing, requires\_capture, canceled, succeeded) |
| ↳ `transfer_data` | json | The data for creating a transfer after the payment succeeds |
| ↳ `transfer_group` | string | Transfer group for transfers associated with the payment |
| `metadata` | json | Payment Intent metadata including ID, status, amount, and currency |
| ↳ `id` | string | Stripe unique identifier |
| ↳ `status` | string | Current state of the resource |
| ↳ `amount` | number | Amount in smallest currency unit (e.g., cents) |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
### Stripe Confirm Payment Intent [#stripe-confirm-payment-intent]
Confirm a Payment Intent and inspect its resulting status. Confirmation can require further action or asynchronous processing before payment succeeds.
#### Input [#input-3]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `id` | string | Yes | Payment Intent ID (e.g., pi\_1234567890) |
| `payment_method` | string | No | Payment method ID to confirm with |
#### Output [#output-3]
| Parameter | Type | Description |
| - | - | - |
| `payment_intent` | object | Stripe Payment Intent object |
| ↳ `id` | string | Unique identifier for the Payment Intent |
| ↳ `object` | string | String representing the object type (payment\_intent) |
| ↳ `amount` | number | Amount intended to be collected in smallest currency unit |
| ↳ `amount_capturable` | number | Amount that can be captured |
| ↳ `amount_received` | number | Amount that was collected |
| ↳ `application` | string | ID of the Connect application that created the PaymentIntent |
| ↳ `application_fee_amount` | number | Application fee amount (if any) |
| ↳ `automatic_payment_methods` | json | Settings for automatic payment methods |
| ↳ `canceled_at` | number | Unix timestamp of cancellation |
| ↳ `cancellation_reason` | string | Reason for cancellation |
| ↳ `capture_method` | string | Controls when funds will be captured (automatic or manual) |
| ↳ `client_secret` | string | Client secret for confirming the PaymentIntent |
| ↳ `confirmation_method` | string | How the PaymentIntent can be confirmed (automatic or manual) |
| ↳ `created` | number | Unix timestamp when the PaymentIntent was created |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
| ↳ `customer` | string | ID of the Customer this PaymentIntent belongs to |
| ↳ `description` | string | Description of the payment |
| ↳ `invoice` | string | ID of the invoice that created this PaymentIntent |
| ↳ `last_payment_error` | json | The payment error encountered in the previous PaymentIntent confirmation |
| ↳ `latest_charge` | string | ID of the latest charge created by this PaymentIntent |
| ↳ `livemode` | boolean | Whether object exists in live mode or test mode |
| ↳ `metadata` | json | Set of key-value pairs for storing additional information |
| ↳ `next_action` | json | Actions required before the PaymentIntent can be confirmed |
| ↳ `on_behalf_of` | string | The account on behalf of which to charge |
| ↳ `payment_method` | string | ID of the payment method used |
| ↳ `payment_method_options` | json | Payment-method-specific configuration |
| ↳ `payment_method_types` | array | Payment method types that can be used |
| ↳ `processing` | json | Processing status if payment is being processed asynchronously |
| ↳ `receipt_email` | string | Email address to send the receipt to |
| ↳ `review` | string | ID of the review associated with this PaymentIntent |
| ↳ `setup_future_usage` | string | Indicates intent to make future payments |
| ↳ `shipping` | object | Shipping information |
| ↳ `name` | string | Recipient name |
| ↳ `phone` | string | Recipient phone number |
| ↳ `address` | object | Address object |
| ↳ `line1` | string | Address line 1 (street address) |
| ↳ `line2` | string | Address line 2 (apartment, suite, etc.) |
| ↳ `city` | string | City name |
| ↳ `state` | string | State, county, province, or region |
| ↳ `postal_code` | string | ZIP or postal code |
| ↳ `country` | string | Two-letter country code (ISO 3166-1 alpha-2) |
| ↳ `statement_descriptor` | string | Statement descriptor for charges |
| ↳ `statement_descriptor_suffix` | string | Statement descriptor suffix |
| ↳ `status` | string | Status of the PaymentIntent (requires\_payment\_method, requires\_confirmation, requires\_action, processing, requires\_capture, canceled, succeeded) |
| ↳ `transfer_data` | json | The data for creating a transfer after the payment succeeds |
| ↳ `transfer_group` | string | Transfer group for transfers associated with the payment |
| `metadata` | json | Payment Intent metadata including ID, status, amount, and currency |
| ↳ `id` | string | Stripe unique identifier |
| ↳ `status` | string | Current state of the resource |
| ↳ `amount` | number | Amount in smallest currency unit (e.g., cents) |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
### Stripe Capture Payment Intent [#stripe-capture-payment-intent]
Capture an authorized Payment Intent
#### Input [#input-4]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `id` | string | Yes | Payment Intent ID (e.g., pi\_1234567890) |
| `amount_to_capture` | number | No | Amount to capture in the currency’s smallest unit (defaults to the full amount) |
#### Output [#output-4]
| Parameter | Type | Description |
| - | - | - |
| `payment_intent` | object | Stripe Payment Intent object |
| ↳ `id` | string | Unique identifier for the Payment Intent |
| ↳ `object` | string | String representing the object type (payment\_intent) |
| ↳ `amount` | number | Amount intended to be collected in smallest currency unit |
| ↳ `amount_capturable` | number | Amount that can be captured |
| ↳ `amount_received` | number | Amount that was collected |
| ↳ `application` | string | ID of the Connect application that created the PaymentIntent |
| ↳ `application_fee_amount` | number | Application fee amount (if any) |
| ↳ `automatic_payment_methods` | json | Settings for automatic payment methods |
| ↳ `canceled_at` | number | Unix timestamp of cancellation |
| ↳ `cancellation_reason` | string | Reason for cancellation |
| ↳ `capture_method` | string | Controls when funds will be captured (automatic or manual) |
| ↳ `client_secret` | string | Client secret for confirming the PaymentIntent |
| ↳ `confirmation_method` | string | How the PaymentIntent can be confirmed (automatic or manual) |
| ↳ `created` | number | Unix timestamp when the PaymentIntent was created |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
| ↳ `customer` | string | ID of the Customer this PaymentIntent belongs to |
| ↳ `description` | string | Description of the payment |
| ↳ `invoice` | string | ID of the invoice that created this PaymentIntent |
| ↳ `last_payment_error` | json | The payment error encountered in the previous PaymentIntent confirmation |
| ↳ `latest_charge` | string | ID of the latest charge created by this PaymentIntent |
| ↳ `livemode` | boolean | Whether object exists in live mode or test mode |
| ↳ `metadata` | json | Set of key-value pairs for storing additional information |
| ↳ `next_action` | json | Actions required before the PaymentIntent can be confirmed |
| ↳ `on_behalf_of` | string | The account on behalf of which to charge |
| ↳ `payment_method` | string | ID of the payment method used |
| ↳ `payment_method_options` | json | Payment-method-specific configuration |
| ↳ `payment_method_types` | array | Payment method types that can be used |
| ↳ `processing` | json | Processing status if payment is being processed asynchronously |
| ↳ `receipt_email` | string | Email address to send the receipt to |
| ↳ `review` | string | ID of the review associated with this PaymentIntent |
| ↳ `setup_future_usage` | string | Indicates intent to make future payments |
| ↳ `shipping` | object | Shipping information |
| ↳ `name` | string | Recipient name |
| ↳ `phone` | string | Recipient phone number |
| ↳ `address` | object | Address object |
| ↳ `line1` | string | Address line 1 (street address) |
| ↳ `line2` | string | Address line 2 (apartment, suite, etc.) |
| ↳ `city` | string | City name |
| ↳ `state` | string | State, county, province, or region |
| ↳ `postal_code` | string | ZIP or postal code |
| ↳ `country` | string | Two-letter country code (ISO 3166-1 alpha-2) |
| ↳ `statement_descriptor` | string | Statement descriptor for charges |
| ↳ `statement_descriptor_suffix` | string | Statement descriptor suffix |
| ↳ `status` | string | Status of the PaymentIntent (requires\_payment\_method, requires\_confirmation, requires\_action, processing, requires\_capture, canceled, succeeded) |
| ↳ `transfer_data` | json | The data for creating a transfer after the payment succeeds |
| ↳ `transfer_group` | string | Transfer group for transfers associated with the payment |
| `metadata` | json | Payment Intent metadata including ID, status, amount, and currency |
| ↳ `id` | string | Stripe unique identifier |
| ↳ `status` | string | Current state of the resource |
| ↳ `amount` | number | Amount in smallest currency unit (e.g., cents) |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
### Stripe Cancel Payment Intent [#stripe-cancel-payment-intent]
Cancel a Payment Intent
#### Input [#input-5]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `id` | string | Yes | Payment Intent ID (e.g., pi\_1234567890) |
| `cancellation_reason` | string | No | Reason for cancellation (duplicate, fraudulent, requested\_by\_customer, abandoned) |
#### Output [#output-5]
| Parameter | Type | Description |
| - | - | - |
| `payment_intent` | object | Stripe Payment Intent object |
| ↳ `id` | string | Unique identifier for the Payment Intent |
| ↳ `object` | string | String representing the object type (payment\_intent) |
| ↳ `amount` | number | Amount intended to be collected in smallest currency unit |
| ↳ `amount_capturable` | number | Amount that can be captured |
| ↳ `amount_received` | number | Amount that was collected |
| ↳ `application` | string | ID of the Connect application that created the PaymentIntent |
| ↳ `application_fee_amount` | number | Application fee amount (if any) |
| ↳ `automatic_payment_methods` | json | Settings for automatic payment methods |
| ↳ `canceled_at` | number | Unix timestamp of cancellation |
| ↳ `cancellation_reason` | string | Reason for cancellation |
| ↳ `capture_method` | string | Controls when funds will be captured (automatic or manual) |
| ↳ `client_secret` | string | Client secret for confirming the PaymentIntent |
| ↳ `confirmation_method` | string | How the PaymentIntent can be confirmed (automatic or manual) |
| ↳ `created` | number | Unix timestamp when the PaymentIntent was created |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
| ↳ `customer` | string | ID of the Customer this PaymentIntent belongs to |
| ↳ `description` | string | Description of the payment |
| ↳ `invoice` | string | ID of the invoice that created this PaymentIntent |
| ↳ `last_payment_error` | json | The payment error encountered in the previous PaymentIntent confirmation |
| ↳ `latest_charge` | string | ID of the latest charge created by this PaymentIntent |
| ↳ `livemode` | boolean | Whether object exists in live mode or test mode |
| ↳ `metadata` | json | Set of key-value pairs for storing additional information |
| ↳ `next_action` | json | Actions required before the PaymentIntent can be confirmed |
| ↳ `on_behalf_of` | string | The account on behalf of which to charge |
| ↳ `payment_method` | string | ID of the payment method used |
| ↳ `payment_method_options` | json | Payment-method-specific configuration |
| ↳ `payment_method_types` | array | Payment method types that can be used |
| ↳ `processing` | json | Processing status if payment is being processed asynchronously |
| ↳ `receipt_email` | string | Email address to send the receipt to |
| ↳ `review` | string | ID of the review associated with this PaymentIntent |
| ↳ `setup_future_usage` | string | Indicates intent to make future payments |
| ↳ `shipping` | object | Shipping information |
| ↳ `name` | string | Recipient name |
| ↳ `phone` | string | Recipient phone number |
| ↳ `address` | object | Address object |
| ↳ `line1` | string | Address line 1 (street address) |
| ↳ `line2` | string | Address line 2 (apartment, suite, etc.) |
| ↳ `city` | string | City name |
| ↳ `state` | string | State, county, province, or region |
| ↳ `postal_code` | string | ZIP or postal code |
| ↳ `country` | string | Two-letter country code (ISO 3166-1 alpha-2) |
| ↳ `statement_descriptor` | string | Statement descriptor for charges |
| ↳ `statement_descriptor_suffix` | string | Statement descriptor suffix |
| ↳ `status` | string | Status of the PaymentIntent (requires\_payment\_method, requires\_confirmation, requires\_action, processing, requires\_capture, canceled, succeeded) |
| ↳ `transfer_data` | json | The data for creating a transfer after the payment succeeds |
| ↳ `transfer_group` | string | Transfer group for transfers associated with the payment |
| `metadata` | json | Payment Intent metadata including ID, status, amount, and currency |
| ↳ `id` | string | Stripe unique identifier |
| ↳ `status` | string | Current state of the resource |
| ↳ `amount` | number | Amount in smallest currency unit (e.g., cents) |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
### Stripe List Payment Intents [#stripe-list-payment-intents]
List all Payment Intents
#### Input [#input-6]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `limit` | number | No | Number of results to return (default 10, max 100) |
| `customer` | string | No | Filter by customer ID |
| `created` | json | No | Filter by creation date (e.g., \{"gt": 1633024800}) |
#### Output [#output-6]
| Parameter | Type | Description |
| - | - | - |
| `payment_intents` | array | Array of Payment Intent objects |
| ↳ `id` | string | Unique identifier for the Payment Intent |
| ↳ `object` | string | String representing the object type (payment\_intent) |
| ↳ `amount` | number | Amount intended to be collected in smallest currency unit |
| ↳ `amount_capturable` | number | Amount that can be captured |
| ↳ `amount_received` | number | Amount that was collected |
| ↳ `application` | string | ID of the Connect application that created the PaymentIntent |
| ↳ `application_fee_amount` | number | Application fee amount (if any) |
| ↳ `automatic_payment_methods` | json | Settings for automatic payment methods |
| ↳ `canceled_at` | number | Unix timestamp of cancellation |
| ↳ `cancellation_reason` | string | Reason for cancellation |
| ↳ `capture_method` | string | Controls when funds will be captured (automatic or manual) |
| ↳ `client_secret` | string | Client secret for confirming the PaymentIntent |
| ↳ `confirmation_method` | string | How the PaymentIntent can be confirmed (automatic or manual) |
| ↳ `created` | number | Unix timestamp when the PaymentIntent was created |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
| ↳ `customer` | string | ID of the Customer this PaymentIntent belongs to |
| ↳ `description` | string | Description of the payment |
| ↳ `invoice` | string | ID of the invoice that created this PaymentIntent |
| ↳ `last_payment_error` | json | The payment error encountered in the previous PaymentIntent confirmation |
| ↳ `latest_charge` | string | ID of the latest charge created by this PaymentIntent |
| ↳ `livemode` | boolean | Whether object exists in live mode or test mode |
| ↳ `metadata` | json | Set of key-value pairs for storing additional information |
| ↳ `next_action` | json | Actions required before the PaymentIntent can be confirmed |
| ↳ `on_behalf_of` | string | The account on behalf of which to charge |
| ↳ `payment_method` | string | ID of the payment method used |
| ↳ `payment_method_options` | json | Payment-method-specific configuration |
| ↳ `payment_method_types` | array | Payment method types that can be used |
| ↳ `processing` | json | Processing status if payment is being processed asynchronously |
| ↳ `receipt_email` | string | Email address to send the receipt to |
| ↳ `review` | string | ID of the review associated with this PaymentIntent |
| ↳ `setup_future_usage` | string | Indicates intent to make future payments |
| ↳ `shipping` | object | Shipping information |
| ↳ `name` | string | Recipient name |
| ↳ `phone` | string | Recipient phone number |
| ↳ `address` | object | Address object |
| ↳ `line1` | string | Address line 1 (street address) |
| ↳ `line2` | string | Address line 2 (apartment, suite, etc.) |
| ↳ `city` | string | City name |
| ↳ `state` | string | State, county, province, or region |
| ↳ `postal_code` | string | ZIP or postal code |
| ↳ `country` | string | Two-letter country code (ISO 3166-1 alpha-2) |
| ↳ `statement_descriptor` | string | Statement descriptor for charges |
| ↳ `statement_descriptor_suffix` | string | Statement descriptor suffix |
| ↳ `status` | string | Status of the PaymentIntent (requires\_payment\_method, requires\_confirmation, requires\_action, processing, requires\_capture, canceled, succeeded) |
| ↳ `transfer_data` | json | The data for creating a transfer after the payment succeeds |
| ↳ `transfer_group` | string | Transfer group for transfers associated with the payment |
| `metadata` | json | List metadata including count and has\_more |
| ↳ `count` | number | Number of items returned |
| ↳ `has_more` | boolean | Whether more items exist beyond this page |
### Stripe Search Payment Intents [#stripe-search-payment-intents]
Search for Payment Intents using query syntax
#### Input [#input-7]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `query` | string | Yes | Search query (e.g., "status:'succeeded' AND currency:'usd'") |
| `limit` | number | No | Number of results to return (default 10, max 100) |
#### Output [#output-7]
| Parameter | Type | Description |
| - | - | - |
| `payment_intents` | array | Array of matching Payment Intent objects |
| ↳ `id` | string | Unique identifier for the Payment Intent |
| ↳ `object` | string | String representing the object type (payment\_intent) |
| ↳ `amount` | number | Amount intended to be collected in smallest currency unit |
| ↳ `amount_capturable` | number | Amount that can be captured |
| ↳ `amount_received` | number | Amount that was collected |
| ↳ `application` | string | ID of the Connect application that created the PaymentIntent |
| ↳ `application_fee_amount` | number | Application fee amount (if any) |
| ↳ `automatic_payment_methods` | json | Settings for automatic payment methods |
| ↳ `canceled_at` | number | Unix timestamp of cancellation |
| ↳ `cancellation_reason` | string | Reason for cancellation |
| ↳ `capture_method` | string | Controls when funds will be captured (automatic or manual) |
| ↳ `client_secret` | string | Client secret for confirming the PaymentIntent |
| ↳ `confirmation_method` | string | How the PaymentIntent can be confirmed (automatic or manual) |
| ↳ `created` | number | Unix timestamp when the PaymentIntent was created |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
| ↳ `customer` | string | ID of the Customer this PaymentIntent belongs to |
| ↳ `description` | string | Description of the payment |
| ↳ `invoice` | string | ID of the invoice that created this PaymentIntent |
| ↳ `last_payment_error` | json | The payment error encountered in the previous PaymentIntent confirmation |
| ↳ `latest_charge` | string | ID of the latest charge created by this PaymentIntent |
| ↳ `livemode` | boolean | Whether object exists in live mode or test mode |
| ↳ `metadata` | json | Set of key-value pairs for storing additional information |
| ↳ `next_action` | json | Actions required before the PaymentIntent can be confirmed |
| ↳ `on_behalf_of` | string | The account on behalf of which to charge |
| ↳ `payment_method` | string | ID of the payment method used |
| ↳ `payment_method_options` | json | Payment-method-specific configuration |
| ↳ `payment_method_types` | array | Payment method types that can be used |
| ↳ `processing` | json | Processing status if payment is being processed asynchronously |
| ↳ `receipt_email` | string | Email address to send the receipt to |
| ↳ `review` | string | ID of the review associated with this PaymentIntent |
| ↳ `setup_future_usage` | string | Indicates intent to make future payments |
| ↳ `shipping` | object | Shipping information |
| ↳ `name` | string | Recipient name |
| ↳ `phone` | string | Recipient phone number |
| ↳ `address` | object | Address object |
| ↳ `line1` | string | Address line 1 (street address) |
| ↳ `line2` | string | Address line 2 (apartment, suite, etc.) |
| ↳ `city` | string | City name |
| ↳ `state` | string | State, county, province, or region |
| ↳ `postal_code` | string | ZIP or postal code |
| ↳ `country` | string | Two-letter country code (ISO 3166-1 alpha-2) |
| ↳ `statement_descriptor` | string | Statement descriptor for charges |
| ↳ `statement_descriptor_suffix` | string | Statement descriptor suffix |
| ↳ `status` | string | Status of the PaymentIntent (requires\_payment\_method, requires\_confirmation, requires\_action, processing, requires\_capture, canceled, succeeded) |
| ↳ `transfer_data` | json | The data for creating a transfer after the payment succeeds |
| ↳ `transfer_group` | string | Transfer group for transfers associated with the payment |
| `metadata` | json | Search metadata including count and has\_more |
| ↳ `count` | number | Number of items returned |
| ↳ `has_more` | boolean | Whether more items exist beyond this page |
### Stripe Create Customer [#stripe-create-customer]
Create a new customer object
#### Input [#input-8]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `email` | string | No | Customer email address |
| `name` | string | No | Customer full name |
| `phone` | string | No | Customer phone number |
| `description` | string | No | Description of the customer |
| `address` | json | No | Customer address object |
| `metadata` | json | No | Set of key-value pairs |
| `payment_method` | string | No | Payment method ID to attach |
#### Output [#output-8]
| Parameter | Type | Description |
| - | - | - |
| `customer` | object | Stripe Customer object |
| ↳ `id` | string | Unique identifier for the customer |
| ↳ `object` | string | String representing the object type (customer) |
| ↳ `address` | object | Address object |
| ↳ `line1` | string | Address line 1 (street address) |
| ↳ `line2` | string | Address line 2 (apartment, suite, etc.) |
| ↳ `city` | string | City name |
| ↳ `state` | string | State, county, province, or region |
| ↳ `postal_code` | string | ZIP or postal code |
| ↳ `country` | string | Two-letter country code (ISO 3166-1 alpha-2) |
| ↳ `balance` | number | Current balance in smallest currency unit |
| ↳ `created` | number | Unix timestamp when the customer was created |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
| ↳ `default_source` | string | ID of the default payment source |
| ↳ `delinquent` | boolean | Whether the customer has unpaid invoices |
| ↳ `description` | string | Description of the customer |
| ↳ `discount` | json | Discount that applies to all recurring charges |
| ↳ `email` | string | Customer email address (max 512 characters) |
| ↳ `invoice_prefix` | string | Prefix for generating unique invoice numbers |
| ↳ `invoice_settings` | json | Default invoice settings |
| ↳ `livemode` | boolean | Whether object exists in live mode or test mode |
| ↳ `metadata` | json | Set of key-value pairs for storing additional information |
| ↳ `name` | string | Customer full name or business name (max 256 characters) |
| ↳ `next_invoice_sequence` | number | Next invoice sequence number |
| ↳ `phone` | string | Customer phone number (max 20 characters) |
| ↳ `preferred_locales` | array | Customer preferred locales |
| ↳ `shipping` | object | Shipping information |
| ↳ `name` | string | Recipient name |
| ↳ `phone` | string | Recipient phone number |
| ↳ `address` | object | Address object |
| ↳ `line1` | string | Address line 1 (street address) |
| ↳ `line2` | string | Address line 2 (apartment, suite, etc.) |
| ↳ `city` | string | City name |
| ↳ `state` | string | State, county, province, or region |
| ↳ `postal_code` | string | ZIP or postal code |
| ↳ `country` | string | Two-letter country code (ISO 3166-1 alpha-2) |
| ↳ `tax_exempt` | string | Tax exemption status (none, exempt, reverse) |
| ↳ `test_clock` | string | ID of the test clock |
| `metadata` | json | Customer metadata |
| ↳ `id` | string | Stripe unique identifier |
| ↳ `email` | string | Customer email address |
| ↳ `name` | string | Display name |
### Stripe Retrieve Customer [#stripe-retrieve-customer]
Retrieve an existing customer by ID
#### Input [#input-9]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `id` | string | Yes | Customer ID (e.g., cus\_1234567890) |
#### Output [#output-9]
| Parameter | Type | Description |
| - | - | - |
| `customer` | object | Stripe Customer object |
| ↳ `id` | string | Unique identifier for the customer |
| ↳ `object` | string | String representing the object type (customer) |
| ↳ `address` | object | Address object |
| ↳ `line1` | string | Address line 1 (street address) |
| ↳ `line2` | string | Address line 2 (apartment, suite, etc.) |
| ↳ `city` | string | City name |
| ↳ `state` | string | State, county, province, or region |
| ↳ `postal_code` | string | ZIP or postal code |
| ↳ `country` | string | Two-letter country code (ISO 3166-1 alpha-2) |
| ↳ `balance` | number | Current balance in smallest currency unit |
| ↳ `created` | number | Unix timestamp when the customer was created |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
| ↳ `default_source` | string | ID of the default payment source |
| ↳ `delinquent` | boolean | Whether the customer has unpaid invoices |
| ↳ `description` | string | Description of the customer |
| ↳ `discount` | json | Discount that applies to all recurring charges |
| ↳ `email` | string | Customer email address (max 512 characters) |
| ↳ `invoice_prefix` | string | Prefix for generating unique invoice numbers |
| ↳ `invoice_settings` | json | Default invoice settings |
| ↳ `livemode` | boolean | Whether object exists in live mode or test mode |
| ↳ `metadata` | json | Set of key-value pairs for storing additional information |
| ↳ `name` | string | Customer full name or business name (max 256 characters) |
| ↳ `next_invoice_sequence` | number | Next invoice sequence number |
| ↳ `phone` | string | Customer phone number (max 20 characters) |
| ↳ `preferred_locales` | array | Customer preferred locales |
| ↳ `shipping` | object | Shipping information |
| ↳ `name` | string | Recipient name |
| ↳ `phone` | string | Recipient phone number |
| ↳ `address` | object | Address object |
| ↳ `line1` | string | Address line 1 (street address) |
| ↳ `line2` | string | Address line 2 (apartment, suite, etc.) |
| ↳ `city` | string | City name |
| ↳ `state` | string | State, county, province, or region |
| ↳ `postal_code` | string | ZIP or postal code |
| ↳ `country` | string | Two-letter country code (ISO 3166-1 alpha-2) |
| ↳ `tax_exempt` | string | Tax exemption status (none, exempt, reverse) |
| ↳ `test_clock` | string | ID of the test clock |
| `metadata` | json | Customer metadata |
| ↳ `id` | string | Stripe unique identifier |
| ↳ `email` | string | Customer email address |
| ↳ `name` | string | Display name |
### Stripe Update Customer [#stripe-update-customer]
Update an existing customer
#### Input [#input-10]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `id` | string | Yes | Customer ID (e.g., cus\_1234567890) |
| `email` | string | No | Updated email address |
| `name` | string | No | Updated name |
| `phone` | string | No | Updated phone number |
| `description` | string | No | Updated description |
| `address` | json | No | Updated address object |
| `metadata` | json | No | Updated metadata |
#### Output [#output-10]
| Parameter | Type | Description |
| - | - | - |
| `customer` | object | Stripe Customer object |
| ↳ `id` | string | Unique identifier for the customer |
| ↳ `object` | string | String representing the object type (customer) |
| ↳ `address` | object | Address object |
| ↳ `line1` | string | Address line 1 (street address) |
| ↳ `line2` | string | Address line 2 (apartment, suite, etc.) |
| ↳ `city` | string | City name |
| ↳ `state` | string | State, county, province, or region |
| ↳ `postal_code` | string | ZIP or postal code |
| ↳ `country` | string | Two-letter country code (ISO 3166-1 alpha-2) |
| ↳ `balance` | number | Current balance in smallest currency unit |
| ↳ `created` | number | Unix timestamp when the customer was created |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
| ↳ `default_source` | string | ID of the default payment source |
| ↳ `delinquent` | boolean | Whether the customer has unpaid invoices |
| ↳ `description` | string | Description of the customer |
| ↳ `discount` | json | Discount that applies to all recurring charges |
| ↳ `email` | string | Customer email address (max 512 characters) |
| ↳ `invoice_prefix` | string | Prefix for generating unique invoice numbers |
| ↳ `invoice_settings` | json | Default invoice settings |
| ↳ `livemode` | boolean | Whether object exists in live mode or test mode |
| ↳ `metadata` | json | Set of key-value pairs for storing additional information |
| ↳ `name` | string | Customer full name or business name (max 256 characters) |
| ↳ `next_invoice_sequence` | number | Next invoice sequence number |
| ↳ `phone` | string | Customer phone number (max 20 characters) |
| ↳ `preferred_locales` | array | Customer preferred locales |
| ↳ `shipping` | object | Shipping information |
| ↳ `name` | string | Recipient name |
| ↳ `phone` | string | Recipient phone number |
| ↳ `address` | object | Address object |
| ↳ `line1` | string | Address line 1 (street address) |
| ↳ `line2` | string | Address line 2 (apartment, suite, etc.) |
| ↳ `city` | string | City name |
| ↳ `state` | string | State, county, province, or region |
| ↳ `postal_code` | string | ZIP or postal code |
| ↳ `country` | string | Two-letter country code (ISO 3166-1 alpha-2) |
| ↳ `tax_exempt` | string | Tax exemption status (none, exempt, reverse) |
| ↳ `test_clock` | string | ID of the test clock |
| `metadata` | json | Customer metadata |
| ↳ `id` | string | Stripe unique identifier |
| ↳ `email` | string | Customer email address |
| ↳ `name` | string | Display name |
### Stripe Delete Customer [#stripe-delete-customer]
Permanently delete a customer
#### Input [#input-11]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `id` | string | Yes | Customer ID (e.g., cus\_1234567890) |
#### Output [#output-11]
| Parameter | Type | Description |
| - | - | - |
| `deleted` | boolean | Whether the resource was deleted |
| `id` | string | ID of the deleted resource |
### Stripe List Customers [#stripe-list-customers]
List all customers
#### Input [#input-12]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `limit` | number | No | Number of results to return (default 10, max 100) |
| `email` | string | No | Filter by email address |
| `created` | json | No | Filter by creation date |
#### Output [#output-12]
| Parameter | Type | Description |
| - | - | - |
| `customers` | array | Array of customer objects |
| ↳ `id` | string | Unique identifier for the customer |
| ↳ `object` | string | String representing the object type (customer) |
| ↳ `address` | object | Address object |
| ↳ `line1` | string | Address line 1 (street address) |
| ↳ `line2` | string | Address line 2 (apartment, suite, etc.) |
| ↳ `city` | string | City name |
| ↳ `state` | string | State, county, province, or region |
| ↳ `postal_code` | string | ZIP or postal code |
| ↳ `country` | string | Two-letter country code (ISO 3166-1 alpha-2) |
| ↳ `balance` | number | Current balance in smallest currency unit |
| ↳ `created` | number | Unix timestamp when the customer was created |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
| ↳ `default_source` | string | ID of the default payment source |
| ↳ `delinquent` | boolean | Whether the customer has unpaid invoices |
| ↳ `description` | string | Description of the customer |
| ↳ `discount` | json | Discount that applies to all recurring charges |
| ↳ `email` | string | Customer email address (max 512 characters) |
| ↳ `invoice_prefix` | string | Prefix for generating unique invoice numbers |
| ↳ `invoice_settings` | json | Default invoice settings |
| ↳ `livemode` | boolean | Whether object exists in live mode or test mode |
| ↳ `metadata` | json | Set of key-value pairs for storing additional information |
| ↳ `name` | string | Customer full name or business name (max 256 characters) |
| ↳ `next_invoice_sequence` | number | Next invoice sequence number |
| ↳ `phone` | string | Customer phone number (max 20 characters) |
| ↳ `preferred_locales` | array | Customer preferred locales |
| ↳ `shipping` | object | Shipping information |
| ↳ `name` | string | Recipient name |
| ↳ `phone` | string | Recipient phone number |
| ↳ `address` | object | Address object |
| ↳ `line1` | string | Address line 1 (street address) |
| ↳ `line2` | string | Address line 2 (apartment, suite, etc.) |
| ↳ `city` | string | City name |
| ↳ `state` | string | State, county, province, or region |
| ↳ `postal_code` | string | ZIP or postal code |
| ↳ `country` | string | Two-letter country code (ISO 3166-1 alpha-2) |
| ↳ `tax_exempt` | string | Tax exemption status (none, exempt, reverse) |
| ↳ `test_clock` | string | ID of the test clock |
| `metadata` | json | List metadata |
| ↳ `count` | number | Number of items returned |
| ↳ `has_more` | boolean | Whether more items exist beyond this page |
### Stripe Search Customers [#stripe-search-customers]
Search for customers using query syntax
#### Input [#input-13]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `query` | string | Yes | Search query (e.g., "email:'[customer@example.com](mailto:customer@example.com)'") |
| `limit` | number | No | Number of results to return (default 10, max 100) |
#### Output [#output-13]
| Parameter | Type | Description |
| - | - | - |
| `customers` | array | Array of matching customer objects |
| ↳ `id` | string | Unique identifier for the customer |
| ↳ `object` | string | String representing the object type (customer) |
| ↳ `address` | object | Address object |
| ↳ `line1` | string | Address line 1 (street address) |
| ↳ `line2` | string | Address line 2 (apartment, suite, etc.) |
| ↳ `city` | string | City name |
| ↳ `state` | string | State, county, province, or region |
| ↳ `postal_code` | string | ZIP or postal code |
| ↳ `country` | string | Two-letter country code (ISO 3166-1 alpha-2) |
| ↳ `balance` | number | Current balance in smallest currency unit |
| ↳ `created` | number | Unix timestamp when the customer was created |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
| ↳ `default_source` | string | ID of the default payment source |
| ↳ `delinquent` | boolean | Whether the customer has unpaid invoices |
| ↳ `description` | string | Description of the customer |
| ↳ `discount` | json | Discount that applies to all recurring charges |
| ↳ `email` | string | Customer email address (max 512 characters) |
| ↳ `invoice_prefix` | string | Prefix for generating unique invoice numbers |
| ↳ `invoice_settings` | json | Default invoice settings |
| ↳ `livemode` | boolean | Whether object exists in live mode or test mode |
| ↳ `metadata` | json | Set of key-value pairs for storing additional information |
| ↳ `name` | string | Customer full name or business name (max 256 characters) |
| ↳ `next_invoice_sequence` | number | Next invoice sequence number |
| ↳ `phone` | string | Customer phone number (max 20 characters) |
| ↳ `preferred_locales` | array | Customer preferred locales |
| ↳ `shipping` | object | Shipping information |
| ↳ `name` | string | Recipient name |
| ↳ `phone` | string | Recipient phone number |
| ↳ `address` | object | Address object |
| ↳ `line1` | string | Address line 1 (street address) |
| ↳ `line2` | string | Address line 2 (apartment, suite, etc.) |
| ↳ `city` | string | City name |
| ↳ `state` | string | State, county, province, or region |
| ↳ `postal_code` | string | ZIP or postal code |
| ↳ `country` | string | Two-letter country code (ISO 3166-1 alpha-2) |
| ↳ `tax_exempt` | string | Tax exemption status (none, exempt, reverse) |
| ↳ `test_clock` | string | ID of the test clock |
| `metadata` | json | Search metadata |
| ↳ `count` | number | Number of items returned |
| ↳ `has_more` | boolean | Whether more items exist beyond this page |
### Stripe Create Subscription [#stripe-create-subscription]
Create a new subscription for a customer
#### Input [#input-14]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `customer` | string | Yes | Customer ID to subscribe |
| `items` | json | Yes | Array of items with price IDs (e.g., \[\{"price": "price\_xxx", "quantity": 1}]) |
| `trial_period_days` | number | No | Number of trial days |
| `default_payment_method` | string | No | Payment method ID |
| `cancel_at_period_end` | boolean | No | Cancel subscription at period end |
| `metadata` | json | No | Set of key-value pairs for storing additional information |
#### Output [#output-14]
| Parameter | Type | Description |
| - | - | - |
| `subscription` | object | Stripe Subscription object |
| ↳ `id` | string | Unique identifier for the subscription |
| ↳ `object` | string | String representing the object type (subscription) |
| ↳ `application` | string | ID of the Connect application that created the subscription |
| ↳ `application_fee_percent` | number | Application fee percent (if any) |
| ↳ `automatic_tax` | json | Automatic tax settings |
| ↳ `billing_cycle_anchor` | number | Unix timestamp determining when billing cycle starts |
| ↳ `billing_thresholds` | json | Billing thresholds for the subscription |
| ↳ `cancel_at` | number | Unix timestamp when the subscription will be canceled |
| ↳ `cancel_at_period_end` | boolean | Whether the subscription will be canceled at period end |
| ↳ `canceled_at` | number | Unix timestamp when the subscription was canceled |
| ↳ `cancellation_details` | json | Details about cancellation |
| ↳ `collection_method` | string | Collection method (charge\_automatically or send\_invoice) |
| ↳ `created` | number | Unix timestamp when the subscription was created |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
| ↳ `current_period_end` | number | Unix timestamp when the current period ends |
| ↳ `current_period_start` | number | Unix timestamp when the current period started |
| ↳ `customer` | string | ID of the customer who owns the subscription |
| ↳ `days_until_due` | number | Number of days a customer has to pay invoices |
| ↳ `default_payment_method` | string | ID of the default payment method |
| ↳ `default_source` | string | ID of the default source |
| ↳ `default_tax_rates` | array | Default tax rates |
| ↳ `description` | string | Subscription description (max 500 characters) |
| ↳ `discount` | json | Discount that applies to the subscription |
| ↳ `ended_at` | number | Unix timestamp when the subscription ended |
| ↳ `items` | object | List of subscription items |
| ↳ `object` | string | String representing the object type (list) |
| ↳ `data` | array | Array of subscription items |
| ↳ `id` | string | Unique identifier for the subscription item |
| ↳ `object` | string | String representing the object type (subscription\_item) |
| ↳ `billing_thresholds` | json | Billing thresholds for the subscription item |
| ↳ `created` | number | Unix timestamp when the item was added |
| ↳ `metadata` | json | Set of key-value pairs for storing additional information |
| ↳ `price` | json | Price object for this subscription item |
| ↳ `quantity` | number | Quantity of the plan to subscribe to |
| ↳ `subscription` | string | ID of the subscription this item belongs to |
| ↳ `tax_rates` | array | Tax rates applied to this subscription item |
| ↳ `has_more` | boolean | Whether there are more items |
| ↳ `url` | string | URL to fetch more items |
| ↳ `latest_invoice` | string | ID of the most recent invoice |
| ↳ `livemode` | boolean | Whether object exists in live mode or test mode |
| ↳ `metadata` | json | Set of key-value pairs for storing additional information |
| ↳ `next_pending_invoice_item_invoice` | number | Unix timestamp of next pending invoice item invoice |
| ↳ `on_behalf_of` | string | Account the subscription is made on behalf of |
| ↳ `pause_collection` | json | If paused, when collection is paused until |
| ↳ `payment_settings` | json | Payment settings for the subscription |
| ↳ `pending_invoice_item_interval` | json | Pending invoice item interval |
| ↳ `pending_setup_intent` | string | ID of the pending SetupIntent |
| ↳ `pending_update` | json | Pending subscription update |
| ↳ `schedule` | string | ID of the subscription schedule |
| ↳ `start_date` | number | Unix timestamp when the subscription started |
| ↳ `status` | string | Status of the subscription (incomplete, incomplete\_expired, trialing, active, past\_due, canceled, unpaid, paused) |
| ↳ `test_clock` | string | ID of the test clock |
| ↳ `transfer_data` | json | Data for creating transfers after payments succeed |
| ↳ `trial_end` | number | Unix timestamp when the trial ends |
| ↳ `trial_settings` | json | Settings related to subscription trials |
| ↳ `trial_start` | number | Unix timestamp when the trial started |
| `metadata` | json | Subscription metadata including ID, status, and customer |
| ↳ `id` | string | Stripe unique identifier |
| ↳ `status` | string | Current state of the resource |
| ↳ `customer` | string | Associated customer ID |
### Stripe Retrieve Subscription [#stripe-retrieve-subscription]
Retrieve an existing subscription by ID
#### Input [#input-15]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `id` | string | Yes | Subscription ID (e.g., sub\_1234567890) |
#### Output [#output-15]
| Parameter | Type | Description |
| - | - | - |
| `subscription` | object | Stripe Subscription object |
| ↳ `id` | string | Unique identifier for the subscription |
| ↳ `object` | string | String representing the object type (subscription) |
| ↳ `application` | string | ID of the Connect application that created the subscription |
| ↳ `application_fee_percent` | number | Application fee percent (if any) |
| ↳ `automatic_tax` | json | Automatic tax settings |
| ↳ `billing_cycle_anchor` | number | Unix timestamp determining when billing cycle starts |
| ↳ `billing_thresholds` | json | Billing thresholds for the subscription |
| ↳ `cancel_at` | number | Unix timestamp when the subscription will be canceled |
| ↳ `cancel_at_period_end` | boolean | Whether the subscription will be canceled at period end |
| ↳ `canceled_at` | number | Unix timestamp when the subscription was canceled |
| ↳ `cancellation_details` | json | Details about cancellation |
| ↳ `collection_method` | string | Collection method (charge\_automatically or send\_invoice) |
| ↳ `created` | number | Unix timestamp when the subscription was created |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
| ↳ `current_period_end` | number | Unix timestamp when the current period ends |
| ↳ `current_period_start` | number | Unix timestamp when the current period started |
| ↳ `customer` | string | ID of the customer who owns the subscription |
| ↳ `days_until_due` | number | Number of days a customer has to pay invoices |
| ↳ `default_payment_method` | string | ID of the default payment method |
| ↳ `default_source` | string | ID of the default source |
| ↳ `default_tax_rates` | array | Default tax rates |
| ↳ `description` | string | Subscription description (max 500 characters) |
| ↳ `discount` | json | Discount that applies to the subscription |
| ↳ `ended_at` | number | Unix timestamp when the subscription ended |
| ↳ `items` | object | List of subscription items |
| ↳ `object` | string | String representing the object type (list) |
| ↳ `data` | array | Array of subscription items |
| ↳ `id` | string | Unique identifier for the subscription item |
| ↳ `object` | string | String representing the object type (subscription\_item) |
| ↳ `billing_thresholds` | json | Billing thresholds for the subscription item |
| ↳ `created` | number | Unix timestamp when the item was added |
| ↳ `metadata` | json | Set of key-value pairs for storing additional information |
| ↳ `price` | json | Price object for this subscription item |
| ↳ `quantity` | number | Quantity of the plan to subscribe to |
| ↳ `subscription` | string | ID of the subscription this item belongs to |
| ↳ `tax_rates` | array | Tax rates applied to this subscription item |
| ↳ `has_more` | boolean | Whether there are more items |
| ↳ `url` | string | URL to fetch more items |
| ↳ `latest_invoice` | string | ID of the most recent invoice |
| ↳ `livemode` | boolean | Whether object exists in live mode or test mode |
| ↳ `metadata` | json | Set of key-value pairs for storing additional information |
| ↳ `next_pending_invoice_item_invoice` | number | Unix timestamp of next pending invoice item invoice |
| ↳ `on_behalf_of` | string | Account the subscription is made on behalf of |
| ↳ `pause_collection` | json | If paused, when collection is paused until |
| ↳ `payment_settings` | json | Payment settings for the subscription |
| ↳ `pending_invoice_item_interval` | json | Pending invoice item interval |
| ↳ `pending_setup_intent` | string | ID of the pending SetupIntent |
| ↳ `pending_update` | json | Pending subscription update |
| ↳ `schedule` | string | ID of the subscription schedule |
| ↳ `start_date` | number | Unix timestamp when the subscription started |
| ↳ `status` | string | Status of the subscription (incomplete, incomplete\_expired, trialing, active, past\_due, canceled, unpaid, paused) |
| ↳ `test_clock` | string | ID of the test clock |
| ↳ `transfer_data` | json | Data for creating transfers after payments succeed |
| ↳ `trial_end` | number | Unix timestamp when the trial ends |
| ↳ `trial_settings` | json | Settings related to subscription trials |
| ↳ `trial_start` | number | Unix timestamp when the trial started |
| `metadata` | json | Subscription metadata including ID, status, and customer |
| ↳ `id` | string | Stripe unique identifier |
| ↳ `status` | string | Current state of the resource |
| ↳ `customer` | string | Associated customer ID |
### Stripe Update Subscription [#stripe-update-subscription]
Update an existing subscription
#### Input [#input-16]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `id` | string | Yes | Subscription ID (e.g., sub\_1234567890) |
| `items` | json | No | Updated array of items with price IDs |
| `cancel_at_period_end` | boolean | No | Cancel subscription at period end |
| `metadata` | json | No | Updated metadata |
#### Output [#output-16]
| Parameter | Type | Description |
| - | - | - |
| `subscription` | object | Stripe Subscription object |
| ↳ `id` | string | Unique identifier for the subscription |
| ↳ `object` | string | String representing the object type (subscription) |
| ↳ `application` | string | ID of the Connect application that created the subscription |
| ↳ `application_fee_percent` | number | Application fee percent (if any) |
| ↳ `automatic_tax` | json | Automatic tax settings |
| ↳ `billing_cycle_anchor` | number | Unix timestamp determining when billing cycle starts |
| ↳ `billing_thresholds` | json | Billing thresholds for the subscription |
| ↳ `cancel_at` | number | Unix timestamp when the subscription will be canceled |
| ↳ `cancel_at_period_end` | boolean | Whether the subscription will be canceled at period end |
| ↳ `canceled_at` | number | Unix timestamp when the subscription was canceled |
| ↳ `cancellation_details` | json | Details about cancellation |
| ↳ `collection_method` | string | Collection method (charge\_automatically or send\_invoice) |
| ↳ `created` | number | Unix timestamp when the subscription was created |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
| ↳ `current_period_end` | number | Unix timestamp when the current period ends |
| ↳ `current_period_start` | number | Unix timestamp when the current period started |
| ↳ `customer` | string | ID of the customer who owns the subscription |
| ↳ `days_until_due` | number | Number of days a customer has to pay invoices |
| ↳ `default_payment_method` | string | ID of the default payment method |
| ↳ `default_source` | string | ID of the default source |
| ↳ `default_tax_rates` | array | Default tax rates |
| ↳ `description` | string | Subscription description (max 500 characters) |
| ↳ `discount` | json | Discount that applies to the subscription |
| ↳ `ended_at` | number | Unix timestamp when the subscription ended |
| ↳ `items` | object | List of subscription items |
| ↳ `object` | string | String representing the object type (list) |
| ↳ `data` | array | Array of subscription items |
| ↳ `id` | string | Unique identifier for the subscription item |
| ↳ `object` | string | String representing the object type (subscription\_item) |
| ↳ `billing_thresholds` | json | Billing thresholds for the subscription item |
| ↳ `created` | number | Unix timestamp when the item was added |
| ↳ `metadata` | json | Set of key-value pairs for storing additional information |
| ↳ `price` | json | Price object for this subscription item |
| ↳ `quantity` | number | Quantity of the plan to subscribe to |
| ↳ `subscription` | string | ID of the subscription this item belongs to |
| ↳ `tax_rates` | array | Tax rates applied to this subscription item |
| ↳ `has_more` | boolean | Whether there are more items |
| ↳ `url` | string | URL to fetch more items |
| ↳ `latest_invoice` | string | ID of the most recent invoice |
| ↳ `livemode` | boolean | Whether object exists in live mode or test mode |
| ↳ `metadata` | json | Set of key-value pairs for storing additional information |
| ↳ `next_pending_invoice_item_invoice` | number | Unix timestamp of next pending invoice item invoice |
| ↳ `on_behalf_of` | string | Account the subscription is made on behalf of |
| ↳ `pause_collection` | json | If paused, when collection is paused until |
| ↳ `payment_settings` | json | Payment settings for the subscription |
| ↳ `pending_invoice_item_interval` | json | Pending invoice item interval |
| ↳ `pending_setup_intent` | string | ID of the pending SetupIntent |
| ↳ `pending_update` | json | Pending subscription update |
| ↳ `schedule` | string | ID of the subscription schedule |
| ↳ `start_date` | number | Unix timestamp when the subscription started |
| ↳ `status` | string | Status of the subscription (incomplete, incomplete\_expired, trialing, active, past\_due, canceled, unpaid, paused) |
| ↳ `test_clock` | string | ID of the test clock |
| ↳ `transfer_data` | json | Data for creating transfers after payments succeed |
| ↳ `trial_end` | number | Unix timestamp when the trial ends |
| ↳ `trial_settings` | json | Settings related to subscription trials |
| ↳ `trial_start` | number | Unix timestamp when the trial started |
| `metadata` | json | Subscription metadata including ID, status, and customer |
| ↳ `id` | string | Stripe unique identifier |
| ↳ `status` | string | Current state of the resource |
| ↳ `customer` | string | Associated customer ID |
### Stripe Cancel Subscription [#stripe-cancel-subscription]
Cancel a subscription
#### Input [#input-17]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `id` | string | Yes | Subscription ID (e.g., sub\_1234567890) |
| `prorate` | boolean | No | Whether to prorate the cancellation |
| `invoice_now` | boolean | No | Whether to invoice immediately |
#### Output [#output-17]
| Parameter | Type | Description |
| - | - | - |
| `subscription` | object | Stripe Subscription object |
| ↳ `id` | string | Unique identifier for the subscription |
| ↳ `object` | string | String representing the object type (subscription) |
| ↳ `application` | string | ID of the Connect application that created the subscription |
| ↳ `application_fee_percent` | number | Application fee percent (if any) |
| ↳ `automatic_tax` | json | Automatic tax settings |
| ↳ `billing_cycle_anchor` | number | Unix timestamp determining when billing cycle starts |
| ↳ `billing_thresholds` | json | Billing thresholds for the subscription |
| ↳ `cancel_at` | number | Unix timestamp when the subscription will be canceled |
| ↳ `cancel_at_period_end` | boolean | Whether the subscription will be canceled at period end |
| ↳ `canceled_at` | number | Unix timestamp when the subscription was canceled |
| ↳ `cancellation_details` | json | Details about cancellation |
| ↳ `collection_method` | string | Collection method (charge\_automatically or send\_invoice) |
| ↳ `created` | number | Unix timestamp when the subscription was created |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
| ↳ `current_period_end` | number | Unix timestamp when the current period ends |
| ↳ `current_period_start` | number | Unix timestamp when the current period started |
| ↳ `customer` | string | ID of the customer who owns the subscription |
| ↳ `days_until_due` | number | Number of days a customer has to pay invoices |
| ↳ `default_payment_method` | string | ID of the default payment method |
| ↳ `default_source` | string | ID of the default source |
| ↳ `default_tax_rates` | array | Default tax rates |
| ↳ `description` | string | Subscription description (max 500 characters) |
| ↳ `discount` | json | Discount that applies to the subscription |
| ↳ `ended_at` | number | Unix timestamp when the subscription ended |
| ↳ `items` | object | List of subscription items |
| ↳ `object` | string | String representing the object type (list) |
| ↳ `data` | array | Array of subscription items |
| ↳ `id` | string | Unique identifier for the subscription item |
| ↳ `object` | string | String representing the object type (subscription\_item) |
| ↳ `billing_thresholds` | json | Billing thresholds for the subscription item |
| ↳ `created` | number | Unix timestamp when the item was added |
| ↳ `metadata` | json | Set of key-value pairs for storing additional information |
| ↳ `price` | json | Price object for this subscription item |
| ↳ `quantity` | number | Quantity of the plan to subscribe to |
| ↳ `subscription` | string | ID of the subscription this item belongs to |
| ↳ `tax_rates` | array | Tax rates applied to this subscription item |
| ↳ `has_more` | boolean | Whether there are more items |
| ↳ `url` | string | URL to fetch more items |
| ↳ `latest_invoice` | string | ID of the most recent invoice |
| ↳ `livemode` | boolean | Whether object exists in live mode or test mode |
| ↳ `metadata` | json | Set of key-value pairs for storing additional information |
| ↳ `next_pending_invoice_item_invoice` | number | Unix timestamp of next pending invoice item invoice |
| ↳ `on_behalf_of` | string | Account the subscription is made on behalf of |
| ↳ `pause_collection` | json | If paused, when collection is paused until |
| ↳ `payment_settings` | json | Payment settings for the subscription |
| ↳ `pending_invoice_item_interval` | json | Pending invoice item interval |
| ↳ `pending_setup_intent` | string | ID of the pending SetupIntent |
| ↳ `pending_update` | json | Pending subscription update |
| ↳ `schedule` | string | ID of the subscription schedule |
| ↳ `start_date` | number | Unix timestamp when the subscription started |
| ↳ `status` | string | Status of the subscription (incomplete, incomplete\_expired, trialing, active, past\_due, canceled, unpaid, paused) |
| ↳ `test_clock` | string | ID of the test clock |
| ↳ `transfer_data` | json | Data for creating transfers after payments succeed |
| ↳ `trial_end` | number | Unix timestamp when the trial ends |
| ↳ `trial_settings` | json | Settings related to subscription trials |
| ↳ `trial_start` | number | Unix timestamp when the trial started |
| `metadata` | json | Subscription metadata including ID, status, and customer |
| ↳ `id` | string | Stripe unique identifier |
| ↳ `status` | string | Current state of the resource |
| ↳ `customer` | string | Associated customer ID |
### Stripe Resume Subscription [#stripe-resume-subscription]
Resume a paused subscription
#### Input [#input-18]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `id` | string | Yes | Subscription ID (e.g., sub\_1234567890) |
#### Output [#output-18]
| Parameter | Type | Description |
| - | - | - |
| `subscription` | object | Stripe Subscription object |
| ↳ `id` | string | Unique identifier for the subscription |
| ↳ `object` | string | String representing the object type (subscription) |
| ↳ `application` | string | ID of the Connect application that created the subscription |
| ↳ `application_fee_percent` | number | Application fee percent (if any) |
| ↳ `automatic_tax` | json | Automatic tax settings |
| ↳ `billing_cycle_anchor` | number | Unix timestamp determining when billing cycle starts |
| ↳ `billing_thresholds` | json | Billing thresholds for the subscription |
| ↳ `cancel_at` | number | Unix timestamp when the subscription will be canceled |
| ↳ `cancel_at_period_end` | boolean | Whether the subscription will be canceled at period end |
| ↳ `canceled_at` | number | Unix timestamp when the subscription was canceled |
| ↳ `cancellation_details` | json | Details about cancellation |
| ↳ `collection_method` | string | Collection method (charge\_automatically or send\_invoice) |
| ↳ `created` | number | Unix timestamp when the subscription was created |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
| ↳ `current_period_end` | number | Unix timestamp when the current period ends |
| ↳ `current_period_start` | number | Unix timestamp when the current period started |
| ↳ `customer` | string | ID of the customer who owns the subscription |
| ↳ `days_until_due` | number | Number of days a customer has to pay invoices |
| ↳ `default_payment_method` | string | ID of the default payment method |
| ↳ `default_source` | string | ID of the default source |
| ↳ `default_tax_rates` | array | Default tax rates |
| ↳ `description` | string | Subscription description (max 500 characters) |
| ↳ `discount` | json | Discount that applies to the subscription |
| ↳ `ended_at` | number | Unix timestamp when the subscription ended |
| ↳ `items` | object | List of subscription items |
| ↳ `object` | string | String representing the object type (list) |
| ↳ `data` | array | Array of subscription items |
| ↳ `id` | string | Unique identifier for the subscription item |
| ↳ `object` | string | String representing the object type (subscription\_item) |
| ↳ `billing_thresholds` | json | Billing thresholds for the subscription item |
| ↳ `created` | number | Unix timestamp when the item was added |
| ↳ `metadata` | json | Set of key-value pairs for storing additional information |
| ↳ `price` | json | Price object for this subscription item |
| ↳ `quantity` | number | Quantity of the plan to subscribe to |
| ↳ `subscription` | string | ID of the subscription this item belongs to |
| ↳ `tax_rates` | array | Tax rates applied to this subscription item |
| ↳ `has_more` | boolean | Whether there are more items |
| ↳ `url` | string | URL to fetch more items |
| ↳ `latest_invoice` | string | ID of the most recent invoice |
| ↳ `livemode` | boolean | Whether object exists in live mode or test mode |
| ↳ `metadata` | json | Set of key-value pairs for storing additional information |
| ↳ `next_pending_invoice_item_invoice` | number | Unix timestamp of next pending invoice item invoice |
| ↳ `on_behalf_of` | string | Account the subscription is made on behalf of |
| ↳ `pause_collection` | json | If paused, when collection is paused until |
| ↳ `payment_settings` | json | Payment settings for the subscription |
| ↳ `pending_invoice_item_interval` | json | Pending invoice item interval |
| ↳ `pending_setup_intent` | string | ID of the pending SetupIntent |
| ↳ `pending_update` | json | Pending subscription update |
| ↳ `schedule` | string | ID of the subscription schedule |
| ↳ `start_date` | number | Unix timestamp when the subscription started |
| ↳ `status` | string | Status of the subscription (incomplete, incomplete\_expired, trialing, active, past\_due, canceled, unpaid, paused) |
| ↳ `test_clock` | string | ID of the test clock |
| ↳ `transfer_data` | json | Data for creating transfers after payments succeed |
| ↳ `trial_end` | number | Unix timestamp when the trial ends |
| ↳ `trial_settings` | json | Settings related to subscription trials |
| ↳ `trial_start` | number | Unix timestamp when the trial started |
| `metadata` | json | Subscription metadata including ID, status, and customer |
| ↳ `id` | string | Stripe unique identifier |
| ↳ `status` | string | Current state of the resource |
| ↳ `customer` | string | Associated customer ID |
### Stripe List Subscriptions [#stripe-list-subscriptions]
List one page of subscriptions. Follow starting\_after while metadata.has\_more is true.
#### Input [#input-19]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `limit` | number | No | Number of results to return (default 10, max 100) |
| `customer` | string | No | Filter by customer ID |
| `status` | string | No | Filter by status (active, past\_due, unpaid, canceled, incomplete, incomplete\_expired, trialing, all) |
| `starting_after` | string | No | Next-page cursor: last subscription ID from the previous page. Do not combine with ending\_before. |
| `ending_before` | string | No | Previous-page cursor: first subscription ID from the current page. Do not combine with starting\_after. |
| `price` | string | No | Filter by price ID |
#### Output [#output-19]
| Parameter | Type | Description |
| - | - | - |
| `subscriptions` | array | Array of subscription objects |
| ↳ `id` | string | Unique identifier for the subscription |
| ↳ `object` | string | String representing the object type (subscription) |
| ↳ `application` | string | ID of the Connect application that created the subscription |
| ↳ `application_fee_percent` | number | Application fee percent (if any) |
| ↳ `automatic_tax` | json | Automatic tax settings |
| ↳ `billing_cycle_anchor` | number | Unix timestamp determining when billing cycle starts |
| ↳ `billing_thresholds` | json | Billing thresholds for the subscription |
| ↳ `cancel_at` | number | Unix timestamp when the subscription will be canceled |
| ↳ `cancel_at_period_end` | boolean | Whether the subscription will be canceled at period end |
| ↳ `canceled_at` | number | Unix timestamp when the subscription was canceled |
| ↳ `cancellation_details` | json | Details about cancellation |
| ↳ `collection_method` | string | Collection method (charge\_automatically or send\_invoice) |
| ↳ `created` | number | Unix timestamp when the subscription was created |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
| ↳ `current_period_end` | number | Unix timestamp when the current period ends |
| ↳ `current_period_start` | number | Unix timestamp when the current period started |
| ↳ `customer` | string | ID of the customer who owns the subscription |
| ↳ `days_until_due` | number | Number of days a customer has to pay invoices |
| ↳ `default_payment_method` | string | ID of the default payment method |
| ↳ `default_source` | string | ID of the default source |
| ↳ `default_tax_rates` | array | Default tax rates |
| ↳ `description` | string | Subscription description (max 500 characters) |
| ↳ `discount` | json | Discount that applies to the subscription |
| ↳ `ended_at` | number | Unix timestamp when the subscription ended |
| ↳ `items` | object | List of subscription items |
| ↳ `object` | string | String representing the object type (list) |
| ↳ `data` | array | Array of subscription items |
| ↳ `id` | string | Unique identifier for the subscription item |
| ↳ `object` | string | String representing the object type (subscription\_item) |
| ↳ `billing_thresholds` | json | Billing thresholds for the subscription item |
| ↳ `created` | number | Unix timestamp when the item was added |
| ↳ `metadata` | json | Set of key-value pairs for storing additional information |
| ↳ `price` | json | Price object for this subscription item |
| ↳ `quantity` | number | Quantity of the plan to subscribe to |
| ↳ `subscription` | string | ID of the subscription this item belongs to |
| ↳ `tax_rates` | array | Tax rates applied to this subscription item |
| ↳ `has_more` | boolean | Whether there are more items |
| ↳ `url` | string | URL to fetch more items |
| ↳ `latest_invoice` | string | ID of the most recent invoice |
| ↳ `livemode` | boolean | Whether object exists in live mode or test mode |
| ↳ `metadata` | json | Set of key-value pairs for storing additional information |
| ↳ `next_pending_invoice_item_invoice` | number | Unix timestamp of next pending invoice item invoice |
| ↳ `on_behalf_of` | string | Account the subscription is made on behalf of |
| ↳ `pause_collection` | json | If paused, when collection is paused until |
| ↳ `payment_settings` | json | Payment settings for the subscription |
| ↳ `pending_invoice_item_interval` | json | Pending invoice item interval |
| ↳ `pending_setup_intent` | string | ID of the pending SetupIntent |
| ↳ `pending_update` | json | Pending subscription update |
| ↳ `schedule` | string | ID of the subscription schedule |
| ↳ `start_date` | number | Unix timestamp when the subscription started |
| ↳ `status` | string | Status of the subscription (incomplete, incomplete\_expired, trialing, active, past\_due, canceled, unpaid, paused) |
| ↳ `test_clock` | string | ID of the test clock |
| ↳ `transfer_data` | json | Data for creating transfers after payments succeed |
| ↳ `trial_end` | number | Unix timestamp when the trial ends |
| ↳ `trial_settings` | json | Settings related to subscription trials |
| ↳ `trial_start` | number | Unix timestamp when the trial started |
| `metadata` | json | List metadata |
| ↳ `count` | number | Number of items returned |
| ↳ `has_more` | boolean | Whether more items exist beyond this page |
### Stripe Search Subscriptions [#stripe-search-subscriptions]
Search one page of subscriptions using query syntax. Pass metadata.next\_page as page to continue.
#### Input [#input-20]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `query` | string | Yes | Search query (e.g., "status:'active' AND metadata\['order\_id']:'6735'") |
| `page` | string | No | Pagination token from metadata.next\_page. Omit for the first page and keep the same query. |
| `limit` | number | No | Number of results to return (default 10, max 100) |
#### Output [#output-20]
| Parameter | Type | Description |
| - | - | - |
| `subscriptions` | array | Array of matching subscription objects |
| ↳ `id` | string | Unique identifier for the subscription |
| ↳ `object` | string | String representing the object type (subscription) |
| ↳ `application` | string | ID of the Connect application that created the subscription |
| ↳ `application_fee_percent` | number | Application fee percent (if any) |
| ↳ `automatic_tax` | json | Automatic tax settings |
| ↳ `billing_cycle_anchor` | number | Unix timestamp determining when billing cycle starts |
| ↳ `billing_thresholds` | json | Billing thresholds for the subscription |
| ↳ `cancel_at` | number | Unix timestamp when the subscription will be canceled |
| ↳ `cancel_at_period_end` | boolean | Whether the subscription will be canceled at period end |
| ↳ `canceled_at` | number | Unix timestamp when the subscription was canceled |
| ↳ `cancellation_details` | json | Details about cancellation |
| ↳ `collection_method` | string | Collection method (charge\_automatically or send\_invoice) |
| ↳ `created` | number | Unix timestamp when the subscription was created |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
| ↳ `current_period_end` | number | Unix timestamp when the current period ends |
| ↳ `current_period_start` | number | Unix timestamp when the current period started |
| ↳ `customer` | string | ID of the customer who owns the subscription |
| ↳ `days_until_due` | number | Number of days a customer has to pay invoices |
| ↳ `default_payment_method` | string | ID of the default payment method |
| ↳ `default_source` | string | ID of the default source |
| ↳ `default_tax_rates` | array | Default tax rates |
| ↳ `description` | string | Subscription description (max 500 characters) |
| ↳ `discount` | json | Discount that applies to the subscription |
| ↳ `ended_at` | number | Unix timestamp when the subscription ended |
| ↳ `items` | object | List of subscription items |
| ↳ `object` | string | String representing the object type (list) |
| ↳ `data` | array | Array of subscription items |
| ↳ `id` | string | Unique identifier for the subscription item |
| ↳ `object` | string | String representing the object type (subscription\_item) |
| ↳ `billing_thresholds` | json | Billing thresholds for the subscription item |
| ↳ `created` | number | Unix timestamp when the item was added |
| ↳ `metadata` | json | Set of key-value pairs for storing additional information |
| ↳ `price` | json | Price object for this subscription item |
| ↳ `quantity` | number | Quantity of the plan to subscribe to |
| ↳ `subscription` | string | ID of the subscription this item belongs to |
| ↳ `tax_rates` | array | Tax rates applied to this subscription item |
| ↳ `has_more` | boolean | Whether there are more items |
| ↳ `url` | string | URL to fetch more items |
| ↳ `latest_invoice` | string | ID of the most recent invoice |
| ↳ `livemode` | boolean | Whether object exists in live mode or test mode |
| ↳ `metadata` | json | Set of key-value pairs for storing additional information |
| ↳ `next_pending_invoice_item_invoice` | number | Unix timestamp of next pending invoice item invoice |
| ↳ `on_behalf_of` | string | Account the subscription is made on behalf of |
| ↳ `pause_collection` | json | If paused, when collection is paused until |
| ↳ `payment_settings` | json | Payment settings for the subscription |
| ↳ `pending_invoice_item_interval` | json | Pending invoice item interval |
| ↳ `pending_setup_intent` | string | ID of the pending SetupIntent |
| ↳ `pending_update` | json | Pending subscription update |
| ↳ `schedule` | string | ID of the subscription schedule |
| ↳ `start_date` | number | Unix timestamp when the subscription started |
| ↳ `status` | string | Status of the subscription (incomplete, incomplete\_expired, trialing, active, past\_due, canceled, unpaid, paused) |
| ↳ `test_clock` | string | ID of the test clock |
| ↳ `transfer_data` | json | Data for creating transfers after payments succeed |
| ↳ `trial_end` | number | Unix timestamp when the trial ends |
| ↳ `trial_settings` | json | Settings related to subscription trials |
| ↳ `trial_start` | number | Unix timestamp when the trial started |
| `metadata` | json | Search metadata |
| ↳ `count` | number | Number of items returned |
| ↳ `has_more` | boolean | Whether more items exist beyond this page |
| ↳ `next_page` | string | Token for the next page of search results, or null when there are no more results |
### Stripe Create Invoice [#stripe-create-invoice]
Create a new invoice
#### Input [#input-21]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `customer` | string | Yes | Customer ID (e.g., cus\_1234567890) |
| `description` | string | No | Description of the invoice |
| `metadata` | json | No | Set of key-value pairs |
| `auto_advance` | boolean | No | Auto-finalize the invoice |
| `collection_method` | string | No | Collection method: charge\_automatically or send\_invoice |
#### Output [#output-21]
| Parameter | Type | Description |
| - | - | - |
| `invoice` | object | Stripe Invoice object |
| ↳ `id` | string | Unique identifier for the invoice |
| ↳ `object` | string | String representing the object type (invoice) |
| ↳ `account_country` | string | Country of the business associated with this invoice |
| ↳ `account_name` | string | Name of the account associated with this invoice |
| ↳ `account_tax_ids` | array | Account tax IDs |
| ↳ `amount_due` | number | Final amount due in smallest currency unit |
| ↳ `amount_paid` | number | Amount paid in smallest currency unit |
| ↳ `amount_remaining` | number | Amount remaining in smallest currency unit |
| ↳ `amount_shipping` | number | Shipping amount in smallest currency unit |
| ↳ `application` | string | ID of the Connect application that created the invoice |
| ↳ `application_fee_amount` | number | Application fee amount |
| ↳ `attempt_count` | number | Number of payment attempts made |
| ↳ `attempted` | boolean | Whether an attempt has been made to pay the invoice |
| ↳ `auto_advance` | boolean | Controls whether Stripe performs automatic collection |
| ↳ `automatic_tax` | json | Settings and results for automatic tax lookup |
| ↳ `billing_reason` | string | Reason the invoice was created |
| ↳ `charge` | string | ID of the latest charge for this invoice |
| ↳ `collection_method` | string | Collection method (charge\_automatically or send\_invoice) |
| ↳ `created` | number | Unix timestamp when the invoice was created |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
| ↳ `custom_fields` | array | Custom fields displayed on the invoice |
| ↳ `customer` | string | ID of the customer who will be billed |
| ↳ `customer_address` | object | Address object |
| ↳ `line1` | string | Address line 1 (street address) |
| ↳ `line2` | string | Address line 2 (apartment, suite, etc.) |
| ↳ `city` | string | City name |
| ↳ `state` | string | State, county, province, or region |
| ↳ `postal_code` | string | ZIP or postal code |
| ↳ `country` | string | Two-letter country code (ISO 3166-1 alpha-2) |
| ↳ `customer_email` | string | Email of the customer |
| ↳ `customer_name` | string | Name of the customer |
| ↳ `customer_phone` | string | Phone number of the customer |
| ↳ `customer_shipping` | object | Shipping information |
| ↳ `name` | string | Recipient name |
| ↳ `phone` | string | Recipient phone number |
| ↳ `address` | object | Address object |
| ↳ `line1` | string | Address line 1 (street address) |
| ↳ `line2` | string | Address line 2 (apartment, suite, etc.) |
| ↳ `city` | string | City name |
| ↳ `state` | string | State, county, province, or region |
| ↳ `postal_code` | string | ZIP or postal code |
| ↳ `country` | string | Two-letter country code (ISO 3166-1 alpha-2) |
| ↳ `customer_tax_exempt` | string | Tax exemption status of the customer |
| ↳ `customer_tax_ids` | array | Customer tax IDs |
| ↳ `default_payment_method` | string | ID of the default payment method |
| ↳ `default_source` | string | ID of the default source |
| ↳ `default_tax_rates` | array | Default tax rates |
| ↳ `description` | string | Description displayed in Dashboard (memo) |
| ↳ `discount` | json | Discount applied to the invoice |
| ↳ `discounts` | array | Discounts applied to the invoice |
| ↳ `due_date` | number | Unix timestamp when payment is due |
| ↳ `effective_at` | number | When the invoice was effective |
| ↳ `ending_balance` | number | Ending customer balance after invoice is finalized |
| ↳ `footer` | string | Footer displayed on the invoice |
| ↳ `from_invoice` | json | Details of the invoice that this invoice was created from |
| ↳ `hosted_invoice_url` | string | URL for the hosted invoice page |
| ↳ `invoice_pdf` | string | URL for the invoice PDF |
| ↳ `issuer` | json | The connected account that issues the invoice |
| ↳ `last_finalization_error` | json | Error encountered during finalization |
| ↳ `latest_revision` | string | ID of the most recent revision |
| ↳ `lines` | object | Invoice line items |
| ↳ `object` | string | String representing the object type (list) |
| ↳ `data` | array | Array of line items |
| ↳ `id` | string | Unique identifier for the line item |
| ↳ `object` | string | String representing the object type (line\_item) |
| ↳ `amount` | number | Amount in smallest currency unit |
| ↳ `amount_excluding_tax` | number | Amount excluding tax |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
| ↳ `description` | string | Description of the line item |
| ↳ `discount_amounts` | array | Discount amounts applied |
| ↳ `discountable` | boolean | Whether the line item is discountable |
| ↳ `discounts` | array | Discounts applied to the line item |
| ↳ `invoice` | string | ID of the invoice that contains this line item |
| ↳ `livemode` | boolean | Whether object exists in live mode or test mode |
| ↳ `metadata` | json | Set of key-value pairs for storing additional information |
| ↳ `period` | json | Period this line item covers |
| ↳ `price` | json | Price object for this line item |
| ↳ `proration` | boolean | Whether this is a proration |
| ↳ `proration_details` | json | Additional details for proration line items |
| ↳ `quantity` | number | Quantity of the item |
| ↳ `subscription` | string | ID of the subscription |
| ↳ `subscription_item` | string | ID of the subscription item |
| ↳ `tax_amounts` | array | Tax amounts for this line item |
| ↳ `tax_rates` | array | Tax rates applied |
| ↳ `type` | string | Type of line item (invoiceitem or subscription) |
| ↳ `unit_amount_excluding_tax` | string | Unit amount excluding tax |
| ↳ `has_more` | boolean | Whether there are more items |
| ↳ `url` | string | URL to fetch more items |
| ↳ `livemode` | boolean | Whether object exists in live mode or test mode |
| ↳ `metadata` | json | Set of key-value pairs for storing additional information |
| ↳ `next_payment_attempt` | number | Unix timestamp of next payment attempt |
| ↳ `number` | string | Human-readable invoice number |
| ↳ `on_behalf_of` | string | Account on behalf of which the invoice was issued |
| ↳ `paid` | boolean | Whether payment was successfully collected |
| ↳ `paid_out_of_band` | boolean | Whether the invoice was paid out of band |
| ↳ `payment_intent` | string | ID of the PaymentIntent associated with the invoice |
| ↳ `payment_settings` | json | Configuration settings for payment collection |
| ↳ `period_end` | number | End of the usage period |
| ↳ `period_start` | number | Start of the usage period |
| ↳ `post_payment_credit_notes_amount` | number | Total of all post-payment credit notes |
| ↳ `pre_payment_credit_notes_amount` | number | Total of all pre-payment credit notes |
| ↳ `quote` | string | ID of the quote this invoice was generated from |
| ↳ `receipt_number` | string | Receipt number for the invoice |
| ↳ `rendering` | json | Invoice rendering options |
| ↳ `rendering_options` | json | Invoice rendering options (deprecated) |
| ↳ `shipping_cost` | json | Shipping cost information |
| ↳ `shipping_details` | object | Shipping information |
| ↳ `name` | string | Recipient name |
| ↳ `phone` | string | Recipient phone number |
| ↳ `address` | object | Address object |
| ↳ `line1` | string | Address line 1 (street address) |
| ↳ `line2` | string | Address line 2 (apartment, suite, etc.) |
| ↳ `city` | string | City name |
| ↳ `state` | string | State, county, province, or region |
| ↳ `postal_code` | string | ZIP or postal code |
| ↳ `country` | string | Two-letter country code (ISO 3166-1 alpha-2) |
| ↳ `starting_balance` | number | Starting customer balance before invoice |
| ↳ `statement_descriptor` | string | Statement descriptor |
| ↳ `status` | string | Status of the invoice (draft, open, paid, uncollectible, void) |
| ↳ `status_transitions` | json | Timestamps at which the invoice status was updated |
| ↳ `subscription` | string | ID of the subscription for this invoice |
| ↳ `subscription_details` | json | Details about the subscription |
| ↳ `subscription_proration_date` | number | Only set for upcoming invoices with proration |
| ↳ `subtotal` | number | Total before discounts and taxes |
| ↳ `subtotal_excluding_tax` | number | Subtotal excluding tax |
| ↳ `tax` | number | Total tax amount |
| ↳ `test_clock` | string | ID of the test clock |
| ↳ `threshold_reason` | json | Details about why the invoice was created |
| ↳ `total` | number | Total after discounts and taxes |
| ↳ `total_discount_amounts` | array | Total discount amounts |
| ↳ `total_excluding_tax` | number | Total excluding tax |
| ↳ `total_tax_amounts` | array | Total tax amounts |
| ↳ `transfer_data` | json | Data for creating transfers |
| ↳ `webhooks_delivered_at` | number | Unix timestamp of webhooks delivery |
| `metadata` | json | Invoice metadata |
| ↳ `id` | string | Stripe unique identifier |
| ↳ `status` | string | Current state of the resource |
| ↳ `amount_due` | number | Amount remaining to be paid in smallest currency unit |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
### Stripe Retrieve Invoice [#stripe-retrieve-invoice]
Retrieve an existing invoice by ID
#### Input [#input-22]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `id` | string | Yes | Invoice ID (e.g., in\_1234567890) |
#### Output [#output-22]
| Parameter | Type | Description |
| - | - | - |
| `invoice` | object | Stripe Invoice object |
| ↳ `id` | string | Unique identifier for the invoice |
| ↳ `object` | string | String representing the object type (invoice) |
| ↳ `account_country` | string | Country of the business associated with this invoice |
| ↳ `account_name` | string | Name of the account associated with this invoice |
| ↳ `account_tax_ids` | array | Account tax IDs |
| ↳ `amount_due` | number | Final amount due in smallest currency unit |
| ↳ `amount_paid` | number | Amount paid in smallest currency unit |
| ↳ `amount_remaining` | number | Amount remaining in smallest currency unit |
| ↳ `amount_shipping` | number | Shipping amount in smallest currency unit |
| ↳ `application` | string | ID of the Connect application that created the invoice |
| ↳ `application_fee_amount` | number | Application fee amount |
| ↳ `attempt_count` | number | Number of payment attempts made |
| ↳ `attempted` | boolean | Whether an attempt has been made to pay the invoice |
| ↳ `auto_advance` | boolean | Controls whether Stripe performs automatic collection |
| ↳ `automatic_tax` | json | Settings and results for automatic tax lookup |
| ↳ `billing_reason` | string | Reason the invoice was created |
| ↳ `charge` | string | ID of the latest charge for this invoice |
| ↳ `collection_method` | string | Collection method (charge\_automatically or send\_invoice) |
| ↳ `created` | number | Unix timestamp when the invoice was created |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
| ↳ `custom_fields` | array | Custom fields displayed on the invoice |
| ↳ `customer` | string | ID of the customer who will be billed |
| ↳ `customer_address` | object | Address object |
| ↳ `line1` | string | Address line 1 (street address) |
| ↳ `line2` | string | Address line 2 (apartment, suite, etc.) |
| ↳ `city` | string | City name |
| ↳ `state` | string | State, county, province, or region |
| ↳ `postal_code` | string | ZIP or postal code |
| ↳ `country` | string | Two-letter country code (ISO 3166-1 alpha-2) |
| ↳ `customer_email` | string | Email of the customer |
| ↳ `customer_name` | string | Name of the customer |
| ↳ `customer_phone` | string | Phone number of the customer |
| ↳ `customer_shipping` | object | Shipping information |
| ↳ `name` | string | Recipient name |
| ↳ `phone` | string | Recipient phone number |
| ↳ `address` | object | Address object |
| ↳ `line1` | string | Address line 1 (street address) |
| ↳ `line2` | string | Address line 2 (apartment, suite, etc.) |
| ↳ `city` | string | City name |
| ↳ `state` | string | State, county, province, or region |
| ↳ `postal_code` | string | ZIP or postal code |
| ↳ `country` | string | Two-letter country code (ISO 3166-1 alpha-2) |
| ↳ `customer_tax_exempt` | string | Tax exemption status of the customer |
| ↳ `customer_tax_ids` | array | Customer tax IDs |
| ↳ `default_payment_method` | string | ID of the default payment method |
| ↳ `default_source` | string | ID of the default source |
| ↳ `default_tax_rates` | array | Default tax rates |
| ↳ `description` | string | Description displayed in Dashboard (memo) |
| ↳ `discount` | json | Discount applied to the invoice |
| ↳ `discounts` | array | Discounts applied to the invoice |
| ↳ `due_date` | number | Unix timestamp when payment is due |
| ↳ `effective_at` | number | When the invoice was effective |
| ↳ `ending_balance` | number | Ending customer balance after invoice is finalized |
| ↳ `footer` | string | Footer displayed on the invoice |
| ↳ `from_invoice` | json | Details of the invoice that this invoice was created from |
| ↳ `hosted_invoice_url` | string | URL for the hosted invoice page |
| ↳ `invoice_pdf` | string | URL for the invoice PDF |
| ↳ `issuer` | json | The connected account that issues the invoice |
| ↳ `last_finalization_error` | json | Error encountered during finalization |
| ↳ `latest_revision` | string | ID of the most recent revision |
| ↳ `lines` | object | Invoice line items |
| ↳ `object` | string | String representing the object type (list) |
| ↳ `data` | array | Array of line items |
| ↳ `id` | string | Unique identifier for the line item |
| ↳ `object` | string | String representing the object type (line\_item) |
| ↳ `amount` | number | Amount in smallest currency unit |
| ↳ `amount_excluding_tax` | number | Amount excluding tax |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
| ↳ `description` | string | Description of the line item |
| ↳ `discount_amounts` | array | Discount amounts applied |
| ↳ `discountable` | boolean | Whether the line item is discountable |
| ↳ `discounts` | array | Discounts applied to the line item |
| ↳ `invoice` | string | ID of the invoice that contains this line item |
| ↳ `livemode` | boolean | Whether object exists in live mode or test mode |
| ↳ `metadata` | json | Set of key-value pairs for storing additional information |
| ↳ `period` | json | Period this line item covers |
| ↳ `price` | json | Price object for this line item |
| ↳ `proration` | boolean | Whether this is a proration |
| ↳ `proration_details` | json | Additional details for proration line items |
| ↳ `quantity` | number | Quantity of the item |
| ↳ `subscription` | string | ID of the subscription |
| ↳ `subscription_item` | string | ID of the subscription item |
| ↳ `tax_amounts` | array | Tax amounts for this line item |
| ↳ `tax_rates` | array | Tax rates applied |
| ↳ `type` | string | Type of line item (invoiceitem or subscription) |
| ↳ `unit_amount_excluding_tax` | string | Unit amount excluding tax |
| ↳ `has_more` | boolean | Whether there are more items |
| ↳ `url` | string | URL to fetch more items |
| ↳ `livemode` | boolean | Whether object exists in live mode or test mode |
| ↳ `metadata` | json | Set of key-value pairs for storing additional information |
| ↳ `next_payment_attempt` | number | Unix timestamp of next payment attempt |
| ↳ `number` | string | Human-readable invoice number |
| ↳ `on_behalf_of` | string | Account on behalf of which the invoice was issued |
| ↳ `paid` | boolean | Whether payment was successfully collected |
| ↳ `paid_out_of_band` | boolean | Whether the invoice was paid out of band |
| ↳ `payment_intent` | string | ID of the PaymentIntent associated with the invoice |
| ↳ `payment_settings` | json | Configuration settings for payment collection |
| ↳ `period_end` | number | End of the usage period |
| ↳ `period_start` | number | Start of the usage period |
| ↳ `post_payment_credit_notes_amount` | number | Total of all post-payment credit notes |
| ↳ `pre_payment_credit_notes_amount` | number | Total of all pre-payment credit notes |
| ↳ `quote` | string | ID of the quote this invoice was generated from |
| ↳ `receipt_number` | string | Receipt number for the invoice |
| ↳ `rendering` | json | Invoice rendering options |
| ↳ `rendering_options` | json | Invoice rendering options (deprecated) |
| ↳ `shipping_cost` | json | Shipping cost information |
| ↳ `shipping_details` | object | Shipping information |
| ↳ `name` | string | Recipient name |
| ↳ `phone` | string | Recipient phone number |
| ↳ `address` | object | Address object |
| ↳ `line1` | string | Address line 1 (street address) |
| ↳ `line2` | string | Address line 2 (apartment, suite, etc.) |
| ↳ `city` | string | City name |
| ↳ `state` | string | State, county, province, or region |
| ↳ `postal_code` | string | ZIP or postal code |
| ↳ `country` | string | Two-letter country code (ISO 3166-1 alpha-2) |
| ↳ `starting_balance` | number | Starting customer balance before invoice |
| ↳ `statement_descriptor` | string | Statement descriptor |
| ↳ `status` | string | Status of the invoice (draft, open, paid, uncollectible, void) |
| ↳ `status_transitions` | json | Timestamps at which the invoice status was updated |
| ↳ `subscription` | string | ID of the subscription for this invoice |
| ↳ `subscription_details` | json | Details about the subscription |
| ↳ `subscription_proration_date` | number | Only set for upcoming invoices with proration |
| ↳ `subtotal` | number | Total before discounts and taxes |
| ↳ `subtotal_excluding_tax` | number | Subtotal excluding tax |
| ↳ `tax` | number | Total tax amount |
| ↳ `test_clock` | string | ID of the test clock |
| ↳ `threshold_reason` | json | Details about why the invoice was created |
| ↳ `total` | number | Total after discounts and taxes |
| ↳ `total_discount_amounts` | array | Total discount amounts |
| ↳ `total_excluding_tax` | number | Total excluding tax |
| ↳ `total_tax_amounts` | array | Total tax amounts |
| ↳ `transfer_data` | json | Data for creating transfers |
| ↳ `webhooks_delivered_at` | number | Unix timestamp of webhooks delivery |
| `metadata` | json | Invoice metadata |
| ↳ `id` | string | Stripe unique identifier |
| ↳ `status` | string | Current state of the resource |
| ↳ `amount_due` | number | Amount remaining to be paid in smallest currency unit |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
### Stripe Update Invoice [#stripe-update-invoice]
Update an existing invoice
#### Input [#input-23]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `id` | string | Yes | Invoice ID (e.g., in\_1234567890) |
| `description` | string | No | Description of the invoice |
| `metadata` | json | No | Set of key-value pairs |
| `auto_advance` | boolean | No | Auto-finalize the invoice |
#### Output [#output-23]
| Parameter | Type | Description |
| - | - | - |
| `invoice` | object | Stripe Invoice object |
| ↳ `id` | string | Unique identifier for the invoice |
| ↳ `object` | string | String representing the object type (invoice) |
| ↳ `account_country` | string | Country of the business associated with this invoice |
| ↳ `account_name` | string | Name of the account associated with this invoice |
| ↳ `account_tax_ids` | array | Account tax IDs |
| ↳ `amount_due` | number | Final amount due in smallest currency unit |
| ↳ `amount_paid` | number | Amount paid in smallest currency unit |
| ↳ `amount_remaining` | number | Amount remaining in smallest currency unit |
| ↳ `amount_shipping` | number | Shipping amount in smallest currency unit |
| ↳ `application` | string | ID of the Connect application that created the invoice |
| ↳ `application_fee_amount` | number | Application fee amount |
| ↳ `attempt_count` | number | Number of payment attempts made |
| ↳ `attempted` | boolean | Whether an attempt has been made to pay the invoice |
| ↳ `auto_advance` | boolean | Controls whether Stripe performs automatic collection |
| ↳ `automatic_tax` | json | Settings and results for automatic tax lookup |
| ↳ `billing_reason` | string | Reason the invoice was created |
| ↳ `charge` | string | ID of the latest charge for this invoice |
| ↳ `collection_method` | string | Collection method (charge\_automatically or send\_invoice) |
| ↳ `created` | number | Unix timestamp when the invoice was created |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
| ↳ `custom_fields` | array | Custom fields displayed on the invoice |
| ↳ `customer` | string | ID of the customer who will be billed |
| ↳ `customer_address` | object | Address object |
| ↳ `line1` | string | Address line 1 (street address) |
| ↳ `line2` | string | Address line 2 (apartment, suite, etc.) |
| ↳ `city` | string | City name |
| ↳ `state` | string | State, county, province, or region |
| ↳ `postal_code` | string | ZIP or postal code |
| ↳ `country` | string | Two-letter country code (ISO 3166-1 alpha-2) |
| ↳ `customer_email` | string | Email of the customer |
| ↳ `customer_name` | string | Name of the customer |
| ↳ `customer_phone` | string | Phone number of the customer |
| ↳ `customer_shipping` | object | Shipping information |
| ↳ `name` | string | Recipient name |
| ↳ `phone` | string | Recipient phone number |
| ↳ `address` | object | Address object |
| ↳ `line1` | string | Address line 1 (street address) |
| ↳ `line2` | string | Address line 2 (apartment, suite, etc.) |
| ↳ `city` | string | City name |
| ↳ `state` | string | State, county, province, or region |
| ↳ `postal_code` | string | ZIP or postal code |
| ↳ `country` | string | Two-letter country code (ISO 3166-1 alpha-2) |
| ↳ `customer_tax_exempt` | string | Tax exemption status of the customer |
| ↳ `customer_tax_ids` | array | Customer tax IDs |
| ↳ `default_payment_method` | string | ID of the default payment method |
| ↳ `default_source` | string | ID of the default source |
| ↳ `default_tax_rates` | array | Default tax rates |
| ↳ `description` | string | Description displayed in Dashboard (memo) |
| ↳ `discount` | json | Discount applied to the invoice |
| ↳ `discounts` | array | Discounts applied to the invoice |
| ↳ `due_date` | number | Unix timestamp when payment is due |
| ↳ `effective_at` | number | When the invoice was effective |
| ↳ `ending_balance` | number | Ending customer balance after invoice is finalized |
| ↳ `footer` | string | Footer displayed on the invoice |
| ↳ `from_invoice` | json | Details of the invoice that this invoice was created from |
| ↳ `hosted_invoice_url` | string | URL for the hosted invoice page |
| ↳ `invoice_pdf` | string | URL for the invoice PDF |
| ↳ `issuer` | json | The connected account that issues the invoice |
| ↳ `last_finalization_error` | json | Error encountered during finalization |
| ↳ `latest_revision` | string | ID of the most recent revision |
| ↳ `lines` | object | Invoice line items |
| ↳ `object` | string | String representing the object type (list) |
| ↳ `data` | array | Array of line items |
| ↳ `id` | string | Unique identifier for the line item |
| ↳ `object` | string | String representing the object type (line\_item) |
| ↳ `amount` | number | Amount in smallest currency unit |
| ↳ `amount_excluding_tax` | number | Amount excluding tax |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
| ↳ `description` | string | Description of the line item |
| ↳ `discount_amounts` | array | Discount amounts applied |
| ↳ `discountable` | boolean | Whether the line item is discountable |
| ↳ `discounts` | array | Discounts applied to the line item |
| ↳ `invoice` | string | ID of the invoice that contains this line item |
| ↳ `livemode` | boolean | Whether object exists in live mode or test mode |
| ↳ `metadata` | json | Set of key-value pairs for storing additional information |
| ↳ `period` | json | Period this line item covers |
| ↳ `price` | json | Price object for this line item |
| ↳ `proration` | boolean | Whether this is a proration |
| ↳ `proration_details` | json | Additional details for proration line items |
| ↳ `quantity` | number | Quantity of the item |
| ↳ `subscription` | string | ID of the subscription |
| ↳ `subscription_item` | string | ID of the subscription item |
| ↳ `tax_amounts` | array | Tax amounts for this line item |
| ↳ `tax_rates` | array | Tax rates applied |
| ↳ `type` | string | Type of line item (invoiceitem or subscription) |
| ↳ `unit_amount_excluding_tax` | string | Unit amount excluding tax |
| ↳ `has_more` | boolean | Whether there are more items |
| ↳ `url` | string | URL to fetch more items |
| ↳ `livemode` | boolean | Whether object exists in live mode or test mode |
| ↳ `metadata` | json | Set of key-value pairs for storing additional information |
| ↳ `next_payment_attempt` | number | Unix timestamp of next payment attempt |
| ↳ `number` | string | Human-readable invoice number |
| ↳ `on_behalf_of` | string | Account on behalf of which the invoice was issued |
| ↳ `paid` | boolean | Whether payment was successfully collected |
| ↳ `paid_out_of_band` | boolean | Whether the invoice was paid out of band |
| ↳ `payment_intent` | string | ID of the PaymentIntent associated with the invoice |
| ↳ `payment_settings` | json | Configuration settings for payment collection |
| ↳ `period_end` | number | End of the usage period |
| ↳ `period_start` | number | Start of the usage period |
| ↳ `post_payment_credit_notes_amount` | number | Total of all post-payment credit notes |
| ↳ `pre_payment_credit_notes_amount` | number | Total of all pre-payment credit notes |
| ↳ `quote` | string | ID of the quote this invoice was generated from |
| ↳ `receipt_number` | string | Receipt number for the invoice |
| ↳ `rendering` | json | Invoice rendering options |
| ↳ `rendering_options` | json | Invoice rendering options (deprecated) |
| ↳ `shipping_cost` | json | Shipping cost information |
| ↳ `shipping_details` | object | Shipping information |
| ↳ `name` | string | Recipient name |
| ↳ `phone` | string | Recipient phone number |
| ↳ `address` | object | Address object |
| ↳ `line1` | string | Address line 1 (street address) |
| ↳ `line2` | string | Address line 2 (apartment, suite, etc.) |
| ↳ `city` | string | City name |
| ↳ `state` | string | State, county, province, or region |
| ↳ `postal_code` | string | ZIP or postal code |
| ↳ `country` | string | Two-letter country code (ISO 3166-1 alpha-2) |
| ↳ `starting_balance` | number | Starting customer balance before invoice |
| ↳ `statement_descriptor` | string | Statement descriptor |
| ↳ `status` | string | Status of the invoice (draft, open, paid, uncollectible, void) |
| ↳ `status_transitions` | json | Timestamps at which the invoice status was updated |
| ↳ `subscription` | string | ID of the subscription for this invoice |
| ↳ `subscription_details` | json | Details about the subscription |
| ↳ `subscription_proration_date` | number | Only set for upcoming invoices with proration |
| ↳ `subtotal` | number | Total before discounts and taxes |
| ↳ `subtotal_excluding_tax` | number | Subtotal excluding tax |
| ↳ `tax` | number | Total tax amount |
| ↳ `test_clock` | string | ID of the test clock |
| ↳ `threshold_reason` | json | Details about why the invoice was created |
| ↳ `total` | number | Total after discounts and taxes |
| ↳ `total_discount_amounts` | array | Total discount amounts |
| ↳ `total_excluding_tax` | number | Total excluding tax |
| ↳ `total_tax_amounts` | array | Total tax amounts |
| ↳ `transfer_data` | json | Data for creating transfers |
| ↳ `webhooks_delivered_at` | number | Unix timestamp of webhooks delivery |
| `metadata` | json | Invoice metadata |
| ↳ `id` | string | Stripe unique identifier |
| ↳ `status` | string | Current state of the resource |
| ↳ `amount_due` | number | Amount remaining to be paid in smallest currency unit |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
### Stripe Delete Invoice [#stripe-delete-invoice]
Permanently delete a draft invoice
#### Input [#input-24]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `id` | string | Yes | Invoice ID (e.g., in\_1234567890) |
#### Output [#output-24]
| Parameter | Type | Description |
| - | - | - |
| `deleted` | boolean | Whether the invoice was deleted |
| `id` | string | The ID of the deleted invoice |
### Stripe Finalize Invoice [#stripe-finalize-invoice]
Finalize a draft invoice
#### Input [#input-25]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `id` | string | Yes | Invoice ID (e.g., in\_1234567890) |
| `auto_advance` | boolean | No | Auto-advance the invoice |
#### Output [#output-25]
| Parameter | Type | Description |
| - | - | - |
| `invoice` | object | Stripe Invoice object |
| ↳ `id` | string | Unique identifier for the invoice |
| ↳ `object` | string | String representing the object type (invoice) |
| ↳ `account_country` | string | Country of the business associated with this invoice |
| ↳ `account_name` | string | Name of the account associated with this invoice |
| ↳ `account_tax_ids` | array | Account tax IDs |
| ↳ `amount_due` | number | Final amount due in smallest currency unit |
| ↳ `amount_paid` | number | Amount paid in smallest currency unit |
| ↳ `amount_remaining` | number | Amount remaining in smallest currency unit |
| ↳ `amount_shipping` | number | Shipping amount in smallest currency unit |
| ↳ `application` | string | ID of the Connect application that created the invoice |
| ↳ `application_fee_amount` | number | Application fee amount |
| ↳ `attempt_count` | number | Number of payment attempts made |
| ↳ `attempted` | boolean | Whether an attempt has been made to pay the invoice |
| ↳ `auto_advance` | boolean | Controls whether Stripe performs automatic collection |
| ↳ `automatic_tax` | json | Settings and results for automatic tax lookup |
| ↳ `billing_reason` | string | Reason the invoice was created |
| ↳ `charge` | string | ID of the latest charge for this invoice |
| ↳ `collection_method` | string | Collection method (charge\_automatically or send\_invoice) |
| ↳ `created` | number | Unix timestamp when the invoice was created |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
| ↳ `custom_fields` | array | Custom fields displayed on the invoice |
| ↳ `customer` | string | ID of the customer who will be billed |
| ↳ `customer_address` | object | Address object |
| ↳ `line1` | string | Address line 1 (street address) |
| ↳ `line2` | string | Address line 2 (apartment, suite, etc.) |
| ↳ `city` | string | City name |
| ↳ `state` | string | State, county, province, or region |
| ↳ `postal_code` | string | ZIP or postal code |
| ↳ `country` | string | Two-letter country code (ISO 3166-1 alpha-2) |
| ↳ `customer_email` | string | Email of the customer |
| ↳ `customer_name` | string | Name of the customer |
| ↳ `customer_phone` | string | Phone number of the customer |
| ↳ `customer_shipping` | object | Shipping information |
| ↳ `name` | string | Recipient name |
| ↳ `phone` | string | Recipient phone number |
| ↳ `address` | object | Address object |
| ↳ `line1` | string | Address line 1 (street address) |
| ↳ `line2` | string | Address line 2 (apartment, suite, etc.) |
| ↳ `city` | string | City name |
| ↳ `state` | string | State, county, province, or region |
| ↳ `postal_code` | string | ZIP or postal code |
| ↳ `country` | string | Two-letter country code (ISO 3166-1 alpha-2) |
| ↳ `customer_tax_exempt` | string | Tax exemption status of the customer |
| ↳ `customer_tax_ids` | array | Customer tax IDs |
| ↳ `default_payment_method` | string | ID of the default payment method |
| ↳ `default_source` | string | ID of the default source |
| ↳ `default_tax_rates` | array | Default tax rates |
| ↳ `description` | string | Description displayed in Dashboard (memo) |
| ↳ `discount` | json | Discount applied to the invoice |
| ↳ `discounts` | array | Discounts applied to the invoice |
| ↳ `due_date` | number | Unix timestamp when payment is due |
| ↳ `effective_at` | number | When the invoice was effective |
| ↳ `ending_balance` | number | Ending customer balance after invoice is finalized |
| ↳ `footer` | string | Footer displayed on the invoice |
| ↳ `from_invoice` | json | Details of the invoice that this invoice was created from |
| ↳ `hosted_invoice_url` | string | URL for the hosted invoice page |
| ↳ `invoice_pdf` | string | URL for the invoice PDF |
| ↳ `issuer` | json | The connected account that issues the invoice |
| ↳ `last_finalization_error` | json | Error encountered during finalization |
| ↳ `latest_revision` | string | ID of the most recent revision |
| ↳ `lines` | object | Invoice line items |
| ↳ `object` | string | String representing the object type (list) |
| ↳ `data` | array | Array of line items |
| ↳ `id` | string | Unique identifier for the line item |
| ↳ `object` | string | String representing the object type (line\_item) |
| ↳ `amount` | number | Amount in smallest currency unit |
| ↳ `amount_excluding_tax` | number | Amount excluding tax |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
| ↳ `description` | string | Description of the line item |
| ↳ `discount_amounts` | array | Discount amounts applied |
| ↳ `discountable` | boolean | Whether the line item is discountable |
| ↳ `discounts` | array | Discounts applied to the line item |
| ↳ `invoice` | string | ID of the invoice that contains this line item |
| ↳ `livemode` | boolean | Whether object exists in live mode or test mode |
| ↳ `metadata` | json | Set of key-value pairs for storing additional information |
| ↳ `period` | json | Period this line item covers |
| ↳ `price` | json | Price object for this line item |
| ↳ `proration` | boolean | Whether this is a proration |
| ↳ `proration_details` | json | Additional details for proration line items |
| ↳ `quantity` | number | Quantity of the item |
| ↳ `subscription` | string | ID of the subscription |
| ↳ `subscription_item` | string | ID of the subscription item |
| ↳ `tax_amounts` | array | Tax amounts for this line item |
| ↳ `tax_rates` | array | Tax rates applied |
| ↳ `type` | string | Type of line item (invoiceitem or subscription) |
| ↳ `unit_amount_excluding_tax` | string | Unit amount excluding tax |
| ↳ `has_more` | boolean | Whether there are more items |
| ↳ `url` | string | URL to fetch more items |
| ↳ `livemode` | boolean | Whether object exists in live mode or test mode |
| ↳ `metadata` | json | Set of key-value pairs for storing additional information |
| ↳ `next_payment_attempt` | number | Unix timestamp of next payment attempt |
| ↳ `number` | string | Human-readable invoice number |
| ↳ `on_behalf_of` | string | Account on behalf of which the invoice was issued |
| ↳ `paid` | boolean | Whether payment was successfully collected |
| ↳ `paid_out_of_band` | boolean | Whether the invoice was paid out of band |
| ↳ `payment_intent` | string | ID of the PaymentIntent associated with the invoice |
| ↳ `payment_settings` | json | Configuration settings for payment collection |
| ↳ `period_end` | number | End of the usage period |
| ↳ `period_start` | number | Start of the usage period |
| ↳ `post_payment_credit_notes_amount` | number | Total of all post-payment credit notes |
| ↳ `pre_payment_credit_notes_amount` | number | Total of all pre-payment credit notes |
| ↳ `quote` | string | ID of the quote this invoice was generated from |
| ↳ `receipt_number` | string | Receipt number for the invoice |
| ↳ `rendering` | json | Invoice rendering options |
| ↳ `rendering_options` | json | Invoice rendering options (deprecated) |
| ↳ `shipping_cost` | json | Shipping cost information |
| ↳ `shipping_details` | object | Shipping information |
| ↳ `name` | string | Recipient name |
| ↳ `phone` | string | Recipient phone number |
| ↳ `address` | object | Address object |
| ↳ `line1` | string | Address line 1 (street address) |
| ↳ `line2` | string | Address line 2 (apartment, suite, etc.) |
| ↳ `city` | string | City name |
| ↳ `state` | string | State, county, province, or region |
| ↳ `postal_code` | string | ZIP or postal code |
| ↳ `country` | string | Two-letter country code (ISO 3166-1 alpha-2) |
| ↳ `starting_balance` | number | Starting customer balance before invoice |
| ↳ `statement_descriptor` | string | Statement descriptor |
| ↳ `status` | string | Status of the invoice (draft, open, paid, uncollectible, void) |
| ↳ `status_transitions` | json | Timestamps at which the invoice status was updated |
| ↳ `subscription` | string | ID of the subscription for this invoice |
| ↳ `subscription_details` | json | Details about the subscription |
| ↳ `subscription_proration_date` | number | Only set for upcoming invoices with proration |
| ↳ `subtotal` | number | Total before discounts and taxes |
| ↳ `subtotal_excluding_tax` | number | Subtotal excluding tax |
| ↳ `tax` | number | Total tax amount |
| ↳ `test_clock` | string | ID of the test clock |
| ↳ `threshold_reason` | json | Details about why the invoice was created |
| ↳ `total` | number | Total after discounts and taxes |
| ↳ `total_discount_amounts` | array | Total discount amounts |
| ↳ `total_excluding_tax` | number | Total excluding tax |
| ↳ `total_tax_amounts` | array | Total tax amounts |
| ↳ `transfer_data` | json | Data for creating transfers |
| ↳ `webhooks_delivered_at` | number | Unix timestamp of webhooks delivery |
| `metadata` | json | Invoice metadata |
| ↳ `id` | string | Stripe unique identifier |
| ↳ `status` | string | Current state of the resource |
| ↳ `amount_due` | number | Amount remaining to be paid in smallest currency unit |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
### Stripe Pay Invoice [#stripe-pay-invoice]
Pay an invoice
#### Input [#input-26]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `id` | string | Yes | Invoice ID (e.g., in\_1234567890) |
| `paid_out_of_band` | boolean | No | Mark invoice as paid out of band |
#### Output [#output-26]
| Parameter | Type | Description |
| - | - | - |
| `invoice` | object | Stripe Invoice object |
| ↳ `id` | string | Unique identifier for the invoice |
| ↳ `object` | string | String representing the object type (invoice) |
| ↳ `account_country` | string | Country of the business associated with this invoice |
| ↳ `account_name` | string | Name of the account associated with this invoice |
| ↳ `account_tax_ids` | array | Account tax IDs |
| ↳ `amount_due` | number | Final amount due in smallest currency unit |
| ↳ `amount_paid` | number | Amount paid in smallest currency unit |
| ↳ `amount_remaining` | number | Amount remaining in smallest currency unit |
| ↳ `amount_shipping` | number | Shipping amount in smallest currency unit |
| ↳ `application` | string | ID of the Connect application that created the invoice |
| ↳ `application_fee_amount` | number | Application fee amount |
| ↳ `attempt_count` | number | Number of payment attempts made |
| ↳ `attempted` | boolean | Whether an attempt has been made to pay the invoice |
| ↳ `auto_advance` | boolean | Controls whether Stripe performs automatic collection |
| ↳ `automatic_tax` | json | Settings and results for automatic tax lookup |
| ↳ `billing_reason` | string | Reason the invoice was created |
| ↳ `charge` | string | ID of the latest charge for this invoice |
| ↳ `collection_method` | string | Collection method (charge\_automatically or send\_invoice) |
| ↳ `created` | number | Unix timestamp when the invoice was created |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
| ↳ `custom_fields` | array | Custom fields displayed on the invoice |
| ↳ `customer` | string | ID of the customer who will be billed |
| ↳ `customer_address` | object | Address object |
| ↳ `line1` | string | Address line 1 (street address) |
| ↳ `line2` | string | Address line 2 (apartment, suite, etc.) |
| ↳ `city` | string | City name |
| ↳ `state` | string | State, county, province, or region |
| ↳ `postal_code` | string | ZIP or postal code |
| ↳ `country` | string | Two-letter country code (ISO 3166-1 alpha-2) |
| ↳ `customer_email` | string | Email of the customer |
| ↳ `customer_name` | string | Name of the customer |
| ↳ `customer_phone` | string | Phone number of the customer |
| ↳ `customer_shipping` | object | Shipping information |
| ↳ `name` | string | Recipient name |
| ↳ `phone` | string | Recipient phone number |
| ↳ `address` | object | Address object |
| ↳ `line1` | string | Address line 1 (street address) |
| ↳ `line2` | string | Address line 2 (apartment, suite, etc.) |
| ↳ `city` | string | City name |
| ↳ `state` | string | State, county, province, or region |
| ↳ `postal_code` | string | ZIP or postal code |
| ↳ `country` | string | Two-letter country code (ISO 3166-1 alpha-2) |
| ↳ `customer_tax_exempt` | string | Tax exemption status of the customer |
| ↳ `customer_tax_ids` | array | Customer tax IDs |
| ↳ `default_payment_method` | string | ID of the default payment method |
| ↳ `default_source` | string | ID of the default source |
| ↳ `default_tax_rates` | array | Default tax rates |
| ↳ `description` | string | Description displayed in Dashboard (memo) |
| ↳ `discount` | json | Discount applied to the invoice |
| ↳ `discounts` | array | Discounts applied to the invoice |
| ↳ `due_date` | number | Unix timestamp when payment is due |
| ↳ `effective_at` | number | When the invoice was effective |
| ↳ `ending_balance` | number | Ending customer balance after invoice is finalized |
| ↳ `footer` | string | Footer displayed on the invoice |
| ↳ `from_invoice` | json | Details of the invoice that this invoice was created from |
| ↳ `hosted_invoice_url` | string | URL for the hosted invoice page |
| ↳ `invoice_pdf` | string | URL for the invoice PDF |
| ↳ `issuer` | json | The connected account that issues the invoice |
| ↳ `last_finalization_error` | json | Error encountered during finalization |
| ↳ `latest_revision` | string | ID of the most recent revision |
| ↳ `lines` | object | Invoice line items |
| ↳ `object` | string | String representing the object type (list) |
| ↳ `data` | array | Array of line items |
| ↳ `id` | string | Unique identifier for the line item |
| ↳ `object` | string | String representing the object type (line\_item) |
| ↳ `amount` | number | Amount in smallest currency unit |
| ↳ `amount_excluding_tax` | number | Amount excluding tax |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
| ↳ `description` | string | Description of the line item |
| ↳ `discount_amounts` | array | Discount amounts applied |
| ↳ `discountable` | boolean | Whether the line item is discountable |
| ↳ `discounts` | array | Discounts applied to the line item |
| ↳ `invoice` | string | ID of the invoice that contains this line item |
| ↳ `livemode` | boolean | Whether object exists in live mode or test mode |
| ↳ `metadata` | json | Set of key-value pairs for storing additional information |
| ↳ `period` | json | Period this line item covers |
| ↳ `price` | json | Price object for this line item |
| ↳ `proration` | boolean | Whether this is a proration |
| ↳ `proration_details` | json | Additional details for proration line items |
| ↳ `quantity` | number | Quantity of the item |
| ↳ `subscription` | string | ID of the subscription |
| ↳ `subscription_item` | string | ID of the subscription item |
| ↳ `tax_amounts` | array | Tax amounts for this line item |
| ↳ `tax_rates` | array | Tax rates applied |
| ↳ `type` | string | Type of line item (invoiceitem or subscription) |
| ↳ `unit_amount_excluding_tax` | string | Unit amount excluding tax |
| ↳ `has_more` | boolean | Whether there are more items |
| ↳ `url` | string | URL to fetch more items |
| ↳ `livemode` | boolean | Whether object exists in live mode or test mode |
| ↳ `metadata` | json | Set of key-value pairs for storing additional information |
| ↳ `next_payment_attempt` | number | Unix timestamp of next payment attempt |
| ↳ `number` | string | Human-readable invoice number |
| ↳ `on_behalf_of` | string | Account on behalf of which the invoice was issued |
| ↳ `paid` | boolean | Whether payment was successfully collected |
| ↳ `paid_out_of_band` | boolean | Whether the invoice was paid out of band |
| ↳ `payment_intent` | string | ID of the PaymentIntent associated with the invoice |
| ↳ `payment_settings` | json | Configuration settings for payment collection |
| ↳ `period_end` | number | End of the usage period |
| ↳ `period_start` | number | Start of the usage period |
| ↳ `post_payment_credit_notes_amount` | number | Total of all post-payment credit notes |
| ↳ `pre_payment_credit_notes_amount` | number | Total of all pre-payment credit notes |
| ↳ `quote` | string | ID of the quote this invoice was generated from |
| ↳ `receipt_number` | string | Receipt number for the invoice |
| ↳ `rendering` | json | Invoice rendering options |
| ↳ `rendering_options` | json | Invoice rendering options (deprecated) |
| ↳ `shipping_cost` | json | Shipping cost information |
| ↳ `shipping_details` | object | Shipping information |
| ↳ `name` | string | Recipient name |
| ↳ `phone` | string | Recipient phone number |
| ↳ `address` | object | Address object |
| ↳ `line1` | string | Address line 1 (street address) |
| ↳ `line2` | string | Address line 2 (apartment, suite, etc.) |
| ↳ `city` | string | City name |
| ↳ `state` | string | State, county, province, or region |
| ↳ `postal_code` | string | ZIP or postal code |
| ↳ `country` | string | Two-letter country code (ISO 3166-1 alpha-2) |
| ↳ `starting_balance` | number | Starting customer balance before invoice |
| ↳ `statement_descriptor` | string | Statement descriptor |
| ↳ `status` | string | Status of the invoice (draft, open, paid, uncollectible, void) |
| ↳ `status_transitions` | json | Timestamps at which the invoice status was updated |
| ↳ `subscription` | string | ID of the subscription for this invoice |
| ↳ `subscription_details` | json | Details about the subscription |
| ↳ `subscription_proration_date` | number | Only set for upcoming invoices with proration |
| ↳ `subtotal` | number | Total before discounts and taxes |
| ↳ `subtotal_excluding_tax` | number | Subtotal excluding tax |
| ↳ `tax` | number | Total tax amount |
| ↳ `test_clock` | string | ID of the test clock |
| ↳ `threshold_reason` | json | Details about why the invoice was created |
| ↳ `total` | number | Total after discounts and taxes |
| ↳ `total_discount_amounts` | array | Total discount amounts |
| ↳ `total_excluding_tax` | number | Total excluding tax |
| ↳ `total_tax_amounts` | array | Total tax amounts |
| ↳ `transfer_data` | json | Data for creating transfers |
| ↳ `webhooks_delivered_at` | number | Unix timestamp of webhooks delivery |
| `metadata` | json | Invoice metadata |
| ↳ `id` | string | Stripe unique identifier |
| ↳ `status` | string | Current state of the resource |
| ↳ `amount_due` | number | Amount remaining to be paid in smallest currency unit |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
### Stripe Void Invoice [#stripe-void-invoice]
Void an invoice
#### Input [#input-27]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `id` | string | Yes | Invoice ID (e.g., in\_1234567890) |
#### Output [#output-27]
| Parameter | Type | Description |
| - | - | - |
| `invoice` | object | Stripe Invoice object |
| ↳ `id` | string | Unique identifier for the invoice |
| ↳ `object` | string | String representing the object type (invoice) |
| ↳ `account_country` | string | Country of the business associated with this invoice |
| ↳ `account_name` | string | Name of the account associated with this invoice |
| ↳ `account_tax_ids` | array | Account tax IDs |
| ↳ `amount_due` | number | Final amount due in smallest currency unit |
| ↳ `amount_paid` | number | Amount paid in smallest currency unit |
| ↳ `amount_remaining` | number | Amount remaining in smallest currency unit |
| ↳ `amount_shipping` | number | Shipping amount in smallest currency unit |
| ↳ `application` | string | ID of the Connect application that created the invoice |
| ↳ `application_fee_amount` | number | Application fee amount |
| ↳ `attempt_count` | number | Number of payment attempts made |
| ↳ `attempted` | boolean | Whether an attempt has been made to pay the invoice |
| ↳ `auto_advance` | boolean | Controls whether Stripe performs automatic collection |
| ↳ `automatic_tax` | json | Settings and results for automatic tax lookup |
| ↳ `billing_reason` | string | Reason the invoice was created |
| ↳ `charge` | string | ID of the latest charge for this invoice |
| ↳ `collection_method` | string | Collection method (charge\_automatically or send\_invoice) |
| ↳ `created` | number | Unix timestamp when the invoice was created |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
| ↳ `custom_fields` | array | Custom fields displayed on the invoice |
| ↳ `customer` | string | ID of the customer who will be billed |
| ↳ `customer_address` | object | Address object |
| ↳ `line1` | string | Address line 1 (street address) |
| ↳ `line2` | string | Address line 2 (apartment, suite, etc.) |
| ↳ `city` | string | City name |
| ↳ `state` | string | State, county, province, or region |
| ↳ `postal_code` | string | ZIP or postal code |
| ↳ `country` | string | Two-letter country code (ISO 3166-1 alpha-2) |
| ↳ `customer_email` | string | Email of the customer |
| ↳ `customer_name` | string | Name of the customer |
| ↳ `customer_phone` | string | Phone number of the customer |
| ↳ `customer_shipping` | object | Shipping information |
| ↳ `name` | string | Recipient name |
| ↳ `phone` | string | Recipient phone number |
| ↳ `address` | object | Address object |
| ↳ `line1` | string | Address line 1 (street address) |
| ↳ `line2` | string | Address line 2 (apartment, suite, etc.) |
| ↳ `city` | string | City name |
| ↳ `state` | string | State, county, province, or region |
| ↳ `postal_code` | string | ZIP or postal code |
| ↳ `country` | string | Two-letter country code (ISO 3166-1 alpha-2) |
| ↳ `customer_tax_exempt` | string | Tax exemption status of the customer |
| ↳ `customer_tax_ids` | array | Customer tax IDs |
| ↳ `default_payment_method` | string | ID of the default payment method |
| ↳ `default_source` | string | ID of the default source |
| ↳ `default_tax_rates` | array | Default tax rates |
| ↳ `description` | string | Description displayed in Dashboard (memo) |
| ↳ `discount` | json | Discount applied to the invoice |
| ↳ `discounts` | array | Discounts applied to the invoice |
| ↳ `due_date` | number | Unix timestamp when payment is due |
| ↳ `effective_at` | number | When the invoice was effective |
| ↳ `ending_balance` | number | Ending customer balance after invoice is finalized |
| ↳ `footer` | string | Footer displayed on the invoice |
| ↳ `from_invoice` | json | Details of the invoice that this invoice was created from |
| ↳ `hosted_invoice_url` | string | URL for the hosted invoice page |
| ↳ `invoice_pdf` | string | URL for the invoice PDF |
| ↳ `issuer` | json | The connected account that issues the invoice |
| ↳ `last_finalization_error` | json | Error encountered during finalization |
| ↳ `latest_revision` | string | ID of the most recent revision |
| ↳ `lines` | object | Invoice line items |
| ↳ `object` | string | String representing the object type (list) |
| ↳ `data` | array | Array of line items |
| ↳ `id` | string | Unique identifier for the line item |
| ↳ `object` | string | String representing the object type (line\_item) |
| ↳ `amount` | number | Amount in smallest currency unit |
| ↳ `amount_excluding_tax` | number | Amount excluding tax |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
| ↳ `description` | string | Description of the line item |
| ↳ `discount_amounts` | array | Discount amounts applied |
| ↳ `discountable` | boolean | Whether the line item is discountable |
| ↳ `discounts` | array | Discounts applied to the line item |
| ↳ `invoice` | string | ID of the invoice that contains this line item |
| ↳ `livemode` | boolean | Whether object exists in live mode or test mode |
| ↳ `metadata` | json | Set of key-value pairs for storing additional information |
| ↳ `period` | json | Period this line item covers |
| ↳ `price` | json | Price object for this line item |
| ↳ `proration` | boolean | Whether this is a proration |
| ↳ `proration_details` | json | Additional details for proration line items |
| ↳ `quantity` | number | Quantity of the item |
| ↳ `subscription` | string | ID of the subscription |
| ↳ `subscription_item` | string | ID of the subscription item |
| ↳ `tax_amounts` | array | Tax amounts for this line item |
| ↳ `tax_rates` | array | Tax rates applied |
| ↳ `type` | string | Type of line item (invoiceitem or subscription) |
| ↳ `unit_amount_excluding_tax` | string | Unit amount excluding tax |
| ↳ `has_more` | boolean | Whether there are more items |
| ↳ `url` | string | URL to fetch more items |
| ↳ `livemode` | boolean | Whether object exists in live mode or test mode |
| ↳ `metadata` | json | Set of key-value pairs for storing additional information |
| ↳ `next_payment_attempt` | number | Unix timestamp of next payment attempt |
| ↳ `number` | string | Human-readable invoice number |
| ↳ `on_behalf_of` | string | Account on behalf of which the invoice was issued |
| ↳ `paid` | boolean | Whether payment was successfully collected |
| ↳ `paid_out_of_band` | boolean | Whether the invoice was paid out of band |
| ↳ `payment_intent` | string | ID of the PaymentIntent associated with the invoice |
| ↳ `payment_settings` | json | Configuration settings for payment collection |
| ↳ `period_end` | number | End of the usage period |
| ↳ `period_start` | number | Start of the usage period |
| ↳ `post_payment_credit_notes_amount` | number | Total of all post-payment credit notes |
| ↳ `pre_payment_credit_notes_amount` | number | Total of all pre-payment credit notes |
| ↳ `quote` | string | ID of the quote this invoice was generated from |
| ↳ `receipt_number` | string | Receipt number for the invoice |
| ↳ `rendering` | json | Invoice rendering options |
| ↳ `rendering_options` | json | Invoice rendering options (deprecated) |
| ↳ `shipping_cost` | json | Shipping cost information |
| ↳ `shipping_details` | object | Shipping information |
| ↳ `name` | string | Recipient name |
| ↳ `phone` | string | Recipient phone number |
| ↳ `address` | object | Address object |
| ↳ `line1` | string | Address line 1 (street address) |
| ↳ `line2` | string | Address line 2 (apartment, suite, etc.) |
| ↳ `city` | string | City name |
| ↳ `state` | string | State, county, province, or region |
| ↳ `postal_code` | string | ZIP or postal code |
| ↳ `country` | string | Two-letter country code (ISO 3166-1 alpha-2) |
| ↳ `starting_balance` | number | Starting customer balance before invoice |
| ↳ `statement_descriptor` | string | Statement descriptor |
| ↳ `status` | string | Status of the invoice (draft, open, paid, uncollectible, void) |
| ↳ `status_transitions` | json | Timestamps at which the invoice status was updated |
| ↳ `subscription` | string | ID of the subscription for this invoice |
| ↳ `subscription_details` | json | Details about the subscription |
| ↳ `subscription_proration_date` | number | Only set for upcoming invoices with proration |
| ↳ `subtotal` | number | Total before discounts and taxes |
| ↳ `subtotal_excluding_tax` | number | Subtotal excluding tax |
| ↳ `tax` | number | Total tax amount |
| ↳ `test_clock` | string | ID of the test clock |
| ↳ `threshold_reason` | json | Details about why the invoice was created |
| ↳ `total` | number | Total after discounts and taxes |
| ↳ `total_discount_amounts` | array | Total discount amounts |
| ↳ `total_excluding_tax` | number | Total excluding tax |
| ↳ `total_tax_amounts` | array | Total tax amounts |
| ↳ `transfer_data` | json | Data for creating transfers |
| ↳ `webhooks_delivered_at` | number | Unix timestamp of webhooks delivery |
| `metadata` | json | Invoice metadata |
| ↳ `id` | string | Stripe unique identifier |
| ↳ `status` | string | Current state of the resource |
| ↳ `amount_due` | number | Amount remaining to be paid in smallest currency unit |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
### Stripe Send Invoice [#stripe-send-invoice]
Send an invoice to the customer
#### Input [#input-28]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `id` | string | Yes | Invoice ID (e.g., in\_1234567890) |
#### Output [#output-28]
| Parameter | Type | Description |
| - | - | - |
| `invoice` | json | The sent invoice object |
| `metadata` | json | Invoice metadata |
| ↳ `id` | string | Stripe unique identifier |
| ↳ `status` | string | Current state of the resource |
| ↳ `amount_due` | number | Amount remaining to be paid in smallest currency unit |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
### Stripe List Invoices [#stripe-list-invoices]
List all invoices
#### Input [#input-29]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `limit` | number | No | Number of results to return (default 10, max 100) |
| `customer` | string | No | Filter by customer ID |
| `status` | string | No | Filter by invoice status |
#### Output [#output-29]
| Parameter | Type | Description |
| - | - | - |
| `invoices` | json | Array of invoice objects |
| `metadata` | json | List metadata |
| ↳ `count` | number | Number of items returned |
| ↳ `has_more` | boolean | Whether more items exist beyond this page |
### Stripe Search Invoices [#stripe-search-invoices]
Search for invoices using query syntax
#### Input [#input-30]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `query` | string | Yes | Search query (e.g., "customer:'cus\_1234567890'") |
| `limit` | number | No | Number of results to return (default 10, max 100) |
#### Output [#output-30]
| Parameter | Type | Description |
| - | - | - |
| `invoices` | json | Array of matching invoice objects |
| `metadata` | json | Search metadata |
| ↳ `count` | number | Number of items returned |
| ↳ `has_more` | boolean | Whether more items exist beyond this page |
### Stripe Create Charge [#stripe-create-charge]
Create a new charge to process a payment
#### Input [#input-31]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `amount` | number | Yes | Amount in the currency’s smallest unit (e.g., 2000 for 20.00 USD) |
| `currency` | string | Yes | Three-letter ISO currency code (e.g., usd, eur) |
| `customer` | string | No | Customer ID to associate with this charge |
| `source` | string | No | Payment source ID (e.g., card token or saved card ID) |
| `description` | string | No | Description of the charge |
| `metadata` | json | No | Set of key-value pairs for storing additional information |
| `capture` | boolean | No | Whether to immediately capture the charge (defaults to true) |
#### Output [#output-31]
| Parameter | Type | Description |
| - | - | - |
| `charge` | json | The created Charge object |
| `metadata` | json | Charge metadata including ID, status, amount, currency, and paid status |
| ↳ `id` | string | Stripe unique identifier |
| ↳ `status` | string | Current state of the resource |
| ↳ `amount` | number | Amount in smallest currency unit (e.g., cents) |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
| ↳ `paid` | boolean | Whether payment has been received |
### Stripe Retrieve Charge [#stripe-retrieve-charge]
Retrieve an existing charge by ID
#### Input [#input-32]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `id` | string | Yes | Charge ID (e.g., ch\_1234567890) |
#### Output [#output-32]
| Parameter | Type | Description |
| - | - | - |
| `charge` | json | The retrieved Charge object |
| `metadata` | json | Charge metadata including ID, status, amount, currency, and paid status |
| ↳ `id` | string | Stripe unique identifier |
| ↳ `status` | string | Current state of the resource |
| ↳ `amount` | number | Amount in smallest currency unit (e.g., cents) |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
| ↳ `paid` | boolean | Whether payment has been received |
### Stripe Update Charge [#stripe-update-charge]
Update an existing charge
#### Input [#input-33]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `id` | string | Yes | Charge ID (e.g., ch\_1234567890) |
| `description` | string | No | Updated description |
| `metadata` | json | No | Updated metadata |
#### Output [#output-33]
| Parameter | Type | Description |
| - | - | - |
| `charge` | json | The updated Charge object |
| `metadata` | json | Charge metadata including ID, status, amount, currency, and paid status |
| ↳ `id` | string | Stripe unique identifier |
| ↳ `status` | string | Current state of the resource |
| ↳ `amount` | number | Amount in smallest currency unit (e.g., cents) |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
| ↳ `paid` | boolean | Whether payment has been received |
### Stripe Capture Charge [#stripe-capture-charge]
Capture an uncaptured charge
#### Input [#input-34]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `id` | string | Yes | Charge ID (e.g., ch\_1234567890) |
| `amount` | number | No | Amount to capture in the currency’s smallest unit (defaults to the full amount) |
#### Output [#output-34]
| Parameter | Type | Description |
| - | - | - |
| `charge` | json | The captured Charge object |
| `metadata` | json | Charge metadata including ID, status, amount, currency, and paid status |
| ↳ `id` | string | Stripe unique identifier |
| ↳ `status` | string | Current state of the resource |
| ↳ `amount` | number | Amount in smallest currency unit (e.g., cents) |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
| ↳ `paid` | boolean | Whether payment has been received |
### Stripe List Charges [#stripe-list-charges]
List all charges
#### Input [#input-35]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `limit` | number | No | Number of results to return (default 10, max 100) |
| `customer` | string | No | Filter by customer ID |
| `created` | json | No | Filter by creation date (e.g., \{"gt": 1633024800}) |
#### Output [#output-35]
| Parameter | Type | Description |
| - | - | - |
| `charges` | json | Array of Charge objects |
| `metadata` | json | List metadata including count and has\_more |
| ↳ `count` | number | Number of items returned |
| ↳ `has_more` | boolean | Whether more items exist beyond this page |
### Stripe Search Charges [#stripe-search-charges]
Search for charges using query syntax
#### Input [#input-36]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `query` | string | Yes | Search query (e.g., "status:'succeeded' AND currency:'usd'") |
| `limit` | number | No | Number of results to return (default 10, max 100) |
#### Output [#output-36]
| Parameter | Type | Description |
| - | - | - |
| `charges` | json | Array of matching Charge objects |
| `metadata` | json | Search metadata including count and has\_more |
| ↳ `count` | number | Number of items returned |
| ↳ `has_more` | boolean | Whether more items exist beyond this page |
### Stripe Create Product [#stripe-create-product]
Create a new product object
#### Input [#input-37]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `name` | string | Yes | Product name |
| `description` | string | No | Product description |
| `active` | boolean | No | Whether the product is active |
| `images` | json | No | Array of image URLs for the product |
| `metadata` | json | No | Set of key-value pairs |
#### Output [#output-37]
| Parameter | Type | Description |
| - | - | - |
| `product` | json | The created product object |
| `metadata` | json | Product metadata |
| ↳ `id` | string | Stripe unique identifier |
| ↳ `name` | string | Display name |
| ↳ `active` | boolean | Whether the resource is currently active |
### Stripe Retrieve Product [#stripe-retrieve-product]
Retrieve an existing product by ID
#### Input [#input-38]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `id` | string | Yes | Product ID (e.g., prod\_1234567890) |
#### Output [#output-38]
| Parameter | Type | Description |
| - | - | - |
| `product` | json | The retrieved product object |
| `metadata` | json | Product metadata |
| ↳ `id` | string | Stripe unique identifier |
| ↳ `name` | string | Display name |
| ↳ `active` | boolean | Whether the resource is currently active |
### Stripe Update Product [#stripe-update-product]
Update an existing product
#### Input [#input-39]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `id` | string | Yes | Product ID (e.g., prod\_1234567890) |
| `name` | string | No | Updated product name |
| `description` | string | No | Updated product description |
| `active` | boolean | No | Updated active status |
| `images` | json | No | Updated array of image URLs |
| `metadata` | json | No | Updated metadata |
#### Output [#output-39]
| Parameter | Type | Description |
| - | - | - |
| `product` | json | The updated product object |
| `metadata` | json | Product metadata |
| ↳ `id` | string | Stripe unique identifier |
| ↳ `name` | string | Display name |
| ↳ `active` | boolean | Whether the resource is currently active |
### Stripe Delete Product [#stripe-delete-product]
Permanently delete a product
#### Input [#input-40]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `id` | string | Yes | Product ID (e.g., prod\_1234567890) |
#### Output [#output-40]
| Parameter | Type | Description |
| - | - | - |
| `deleted` | boolean | Whether the product was deleted |
| `id` | string | The ID of the deleted product |
### Stripe List Products [#stripe-list-products]
List all products
#### Input [#input-41]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `limit` | number | No | Number of results to return (default 10, max 100) |
| `active` | boolean | No | Filter by active status |
#### Output [#output-41]
| Parameter | Type | Description |
| - | - | - |
| `products` | json | Array of product objects |
| `metadata` | json | List metadata |
| ↳ `count` | number | Number of items returned |
| ↳ `has_more` | boolean | Whether more items exist beyond this page |
### Stripe Search Products [#stripe-search-products]
Search for products using query syntax
#### Input [#input-42]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `query` | string | Yes | Search query (e.g., "name:'shirt'") |
| `limit` | number | No | Number of results to return (default 10, max 100) |
#### Output [#output-42]
| Parameter | Type | Description |
| - | - | - |
| `products` | json | Array of matching product objects |
| `metadata` | json | Search metadata |
| ↳ `count` | number | Number of items returned |
| ↳ `has_more` | boolean | Whether more items exist beyond this page |
### Stripe Create Price [#stripe-create-price]
Create a new price for a product
#### Input [#input-43]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `product` | string | Yes | Product ID (e.g., prod\_1234567890) |
| `currency` | string | Yes | Three-letter ISO currency code (e.g., usd, eur) |
| `unit_amount` | number | No | Amount in the currency’s smallest unit (e.g., 1000 for 10.00 USD) |
| `recurring` | json | No | Recurring billing configuration (interval: day/week/month/year) |
| `metadata` | json | No | Set of key-value pairs |
| `billing_scheme` | string | No | Billing scheme (per\_unit or tiered) |
#### Output [#output-43]
| Parameter | Type | Description |
| - | - | - |
| `price` | json | The created price object |
| `metadata` | json | Price metadata |
| ↳ `id` | string | Stripe unique identifier |
| ↳ `product` | string | Associated product ID |
| ↳ `unit_amount` | number | Amount in smallest currency unit (e.g., cents) |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
### Stripe Retrieve Price [#stripe-retrieve-price]
Retrieve an existing price by ID
#### Input [#input-44]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `id` | string | Yes | Price ID (e.g., price\_1234567890) |
#### Output [#output-44]
| Parameter | Type | Description |
| - | - | - |
| `price` | json | The retrieved price object |
| `metadata` | json | Price metadata |
| ↳ `id` | string | Stripe unique identifier |
| ↳ `product` | string | Associated product ID |
| ↳ `unit_amount` | number | Amount in smallest currency unit (e.g., cents) |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
### Stripe Update Price [#stripe-update-price]
Update an existing price
#### Input [#input-45]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `id` | string | Yes | Price ID (e.g., price\_1234567890) |
| `active` | boolean | No | Whether the price is active |
| `metadata` | json | No | Updated metadata |
#### Output [#output-45]
| Parameter | Type | Description |
| - | - | - |
| `price` | json | The updated price object |
| `metadata` | json | Price metadata |
| ↳ `id` | string | Stripe unique identifier |
| ↳ `product` | string | Associated product ID |
| ↳ `unit_amount` | number | Amount in smallest currency unit (e.g., cents) |
| ↳ `currency` | string | Three-letter ISO currency code (lowercase) |
### Stripe List Prices [#stripe-list-prices]
List all prices
#### Input [#input-46]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `limit` | number | No | Number of results to return (default 10, max 100) |
| `product` | string | No | Filter by product ID |
| `active` | boolean | No | Filter by active status |
#### Output [#output-46]
| Parameter | Type | Description |
| - | - | - |
| `prices` | json | Array of price objects |
| `metadata` | json | List metadata |
| ↳ `count` | number | Number of items returned |
| ↳ `has_more` | boolean | Whether more items exist beyond this page |
### Stripe Search Prices [#stripe-search-prices]
Search for prices using query syntax
#### Input [#input-47]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `query` | string | Yes | Search query (e.g., "active:'true' AND currency:'usd'") |
| `limit` | number | No | Number of results to return (default 10, max 100) |
#### Output [#output-47]
| Parameter | Type | Description |
| - | - | - |
| `prices` | json | Array of matching price objects |
| `metadata` | json | Search metadata |
| ↳ `count` | number | Number of items returned |
| ↳ `has_more` | boolean | Whether more items exist beyond this page |
### Stripe Retrieve Event [#stripe-retrieve-event]
Retrieve an existing Event by ID
#### Input [#input-48]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `id` | string | Yes | Event ID (e.g., evt\_1234567890) |
#### Output [#output-48]
| Parameter | Type | Description |
| - | - | - |
| `event` | json | The retrieved Event object |
| `metadata` | json | Event metadata including ID, type, and created timestamp |
| ↳ `id` | string | Stripe unique identifier |
| ↳ `type` | string | Event type identifier |
| ↳ `created` | number | Unix timestamp of creation |
### Stripe List Events [#stripe-list-events]
List all Events
#### Input [#input-49]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `apiKey` | string | Yes | Stripe API key (secret key) |
| `limit` | number | No | Number of results to return (default 10, max 100) |
| `type` | string | No | Filter by event type (e.g., payment\_intent.created) |
| `created` | json | No | Filter by creation date (e.g., \{"gt": 1633024800}) |
#### Output [#output-49]
| Parameter | Type | Description |
| - | - | - |
| `events` | json | Array of Event objects |
| `metadata` | json | List metadata including count and has\_more |
| ↳ `count` | number | Number of items returned |
| ↳ `has_more` | boolean | Whether more items exist beyond this page |
## Triggers [#triggers]
A trigger starts a workflow when a supported event occurs in this service.
### Stripe Webhook [#stripe-webhook]
Triggers when Stripe events occur (payments, subscriptions, invoices, etc.)
#### Configuration [#configuration]
| Parameter | Type | Required | Description |
| - | - | - | - |
| `eventTypes` | string | No | Select specific Stripe events to filter. Leave empty to receive all events from Stripe. |
| `webhookSecret` | string | No | Your webhook signing secret from Stripe Dashboard. Used to verify webhook authenticity. |
#### Output [#output-50]
| Parameter | Type | Description |
| - | - | - |
| `id` | string | Unique identifier for the event |
| `type` | string | Event type (e.g., payment\_intent.succeeded, customer.created, invoice.paid) |
| `object` | string | Always "event" |
| `api_version` | string | Stripe API version used to render the event |
| `created` | number | Unix timestamp when the event was created |
| `data` | json | Event data containing the affected Stripe object. Structure varies by event type - access via data.object for the resource (PaymentIntent, Customer, Invoice, etc.) |
| `livemode` | boolean | Whether this event occurred in live mode (true) or test mode (false) |
| `pending_webhooks` | number | Number of webhooks yet to be delivered for this event |
| `request` | json | Information about the API request that triggered this event (id, idempotency\_key) |