Stripe

Parámetros de entrada

• prorateboolean

  If true, generates a proration invoice item for unused time remaining in the current billing cycle.

• invoice_nowboolean

  If true, generates a final invoice for any un-invoiced metered usage.

• subscription_idstringObligatorio

  Identifier of the subscription to cancel.

• cancellation_detailsobject

  Specifies reasons for cancellation. Common keys: 'comment' (free-form text) and 'feedback' (e.g., 'customer_service', 'low_usage', 'switched_service'). Example: {'comment': 'Switching services.', 'feedback': 'switched_service'}

Parámetros de salida

• dataobjectObligatorio

  The full Stripe Subscription object that has been canceled.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• shippingobject

  Shipping information, overriding any previously set; provide a dictionary with address details.

• return_urlstring

  URL for customer redirection after authentication steps (e.g., 3D Secure); necessary for redirection-based payment methods.

• receipt_emailstring

  Email address for Stripe to send a receipt, overriding any previously set on the PaymentIntent.

• capture_methodstring

  Controls fund capture (`automatic` for immediate, `manual` for later authorization), overriding the PaymentIntent's setting. Can change from `manual` to `automatic`, but not from `automatic` to `manual` during confirmation.

• payment_methodstring

  ID of the PaymentMethod to attach; if omitted, Stripe uses the latest associated payment method.

• payment_intent_idstringObligatorio

  The unique identifier of the PaymentIntent to be confirmed.

• setup_future_usagestring

  Indicates intent to save the payment method for future use (`on_session` or `off_session`), overriding any previously set value.

Parámetros de salida

• dataobjectObligatorio

  The full Stripe PaymentIntent object representing the confirmed payment, including its status and details.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestring

  The customer's full name or the name of the business.

• emailstring

  The customer's primary email address, used by Stripe for sending invoices, receipts, and other important communications.

• phonestring

  The customer's primary phone number. Include the country code for international numbers (e.g., +1 for the USA).

• addressobject

  The customer's billing address, provided as a dictionary where both keys and values are strings. This address can be used for tax calculation, shipping, and fraud prevention. Common keys include: `line1` (street address, P.O. box, or c/o), `line2` (apartment, suite, unit, or building), `city`, `state` (state, province, or region), `postal_code` (ZIP or postal code), and `country` (a two-letter ISO country code, e.g., 'US', 'GB'). All keys are optional.

• descriptionstring

  An arbitrary string that you can attach to a customer object for your internal reference (e.g., notes about the customer). This is not visible to the customer.

Parámetros de salida

• dataobjectObligatorio

  The complete JSON response from the Stripe API, representing the created customer object. This typically includes the customer's ID, and all other attributes of the customer, such as email, name, address (if provided), etc.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• footerstring

  A custom footer text to display on the invoice PDF.

• issuerobject

  Details about the entity that is issuing the invoice. Applicable for Stripe Connect.

• numberstring

  A custom number to identify this invoice. If not provided, Stripe will generate one. It must be unique.

• currencystring

  The three-letter ISO currency code (e.g., usd, eur). Must be a supported currency. Defaults to the customer's currency, or the subscription's currency if `subscription` is provided.

• customerstringObligatorio

  The ID of the customer to be billed.

• due_dateinteger

  The date on which the invoice is due. Unix timestamp in seconds. MUST be a future date. Only applicable if `collection_method` is 'send_invoice'. Cannot be used with `days_until_due`. IMPORTANT FOR DATE CONVERSION: - Always convert natural language dates to Unix timestamps representing future dates - Use the current date as reference point - do NOT use outdated reference dates - Common conversion errors: "June 15, 2025" should be ~1749925800 (not 1718755200 which is June 2024) EXAMPLES OF CORRECT CONVERSIONS (based on current date): - "June 15, 2025" → 1749925800 - "December 31, 2025" → 1767196800 - "Next month" → Calculate from current date + 30 days - "In 30 days" → Calculate from current date + 30 days VALIDATION: Before using any timestamp, verify it represents a FUTURE date by checking: - The timestamp should be greater than current Unix timestamp - Convert back to human date to confirm it matches the intended future date Example: For June 15, 2025, use 1749925800 (verified future date).

• metadataobject

  A set of key-value pairs to store additional information about the object. This is useful for storing custom data.

• discountsobject[]

  The discounts to apply to the invoice. This can include coupon IDs or discount IDs.

• renderingobject

  Options for customizing the invoice PDF appearance.

• descriptionstring

  An arbitrary string attached to the invoice, often visible to the customer.

• auto_advanceboolean

  Controls whether Stripe automatically finalizes and attempts payment on this invoice. When false, the invoice remains a draft. Defaults to true for `collection_method='charge_automatically'`, and false for `collection_method='send_invoice'`.

• from_invoiceobject

  Details for revising an existing invoice.

• on_behalf_ofstring

  The Stripe account ID on behalf of which to charge. Used with Stripe Connect.

• subscriptionstring

  The ID of the subscription to which this invoice belongs. If provided, the invoice will bill for the subscription's items.

• automatic_taxobject

  Configuration for Stripe's automatic tax calculation on the invoice.

• custom_fieldsobject[]

  A list of custom fields to display on the invoice. Each field consists of a name and a value.

• shipping_costobject

  Shipping cost for the invoice. Provide an existing `shipping_rate` ID or define `shipping_rate_data`.

• transfer_dataobject

  For Stripe Connect, details of the destination account for transferring funds from this invoice.

• days_until_dueinteger

  The number of days from when the invoice is finalized until it is due. Only applicable if `collection_method` is 'send_invoice'. Cannot be used with `due_date`. RECOMMENDED APPROACH: When users specify future dates in natural language (like "due in 30 days" or "due next month"), using `days_until_due` is safer than converting to Unix timestamps with `due_date`, as it avoids potential timestamp conversion errors. EXAMPLES: - "Due in 30 days" → days_until_due: 30 - "Due next month" → days_until_due: 30 - "Due in two weeks" → days_until_due: 14 - "Net 15 terms" → days_until_due: 15

• default_sourcestring

  ID of the default payment source (e.g., card) to be used for this invoice. Deprecated in favor of `default_payment_method`.

• account_tax_idsstring[]

  A list of tax IDs that apply to this invoice. These IDs will override the `default_tax_rates` on the Customer.

• payment_settingsobject

  Settings for the invoice payment process.

• shipping_detailsobject

  Shipping details for the invoice recipient.

• collection_methodstring

  Specifies how the invoice payment is collected. Can be 'charge_automatically' to attempt payment immediately or 'send_invoice' to email the invoice to the customer for manual payment. Defaults to 'charge_automatically'.

• default_tax_ratesstring[]

  A list of IDs of tax rates that will apply to any line item on the invoice for which tax rates are not explicitly defined.

• statement_descriptorstring

  An arbitrary string to be displayed on the customer's credit card statement. This may be truncated to 22 characters.

• application_fee_amountinteger

  A non-negative integer in cents (or the smallest currency unit) representing the fee amount for the application that will be applied to the invoice. This is used for Stripe Connect.

• default_payment_methodstring

  ID of the default payment method to be used for this invoice.

• automatically_finalizes_atinteger

  A Unix timestamp representing the date and time when this draft invoice will be automatically finalized.

• pending_invoice_items_behaviorstring

  Determines how pending invoice items are handled during invoice finalization. Can be 'include' to include all pending items, or 'exclude' to ignore them. Defaults to 'include'.

Parámetros de salida

• dataobjectObligatorio

  The full JSON response from the Stripe API representing the created invoice object.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• amountintegerObligatorio

  Amount intended to be collected, specified in the smallest currency unit (e.g., 5000 for $50.00 USD).

• confirmboolean

  Set to `true` to attempt to confirm this PaymentIntent immediately after creation. If the payment method requires any follow-up actions (e.g., 3D Secure authentication), this PaymentIntent will transition to a status requiring further action.

• currencystringObligatorio

  Three-letter ISO currency code (e.g., 'usd', 'eur').

• customerstring

  ID of the Customer for this PaymentIntent, if one exists. Allows attaching payment method to Customer for future use.

• metadataobject

  Key-value pairs to attach to the PaymentIntent for storing additional structured information.

• shippingobject

  Shipping information for this PaymentIntent. Required for certain payment methods or if calculating tax.

• return_urlstring

  URL to redirect customer to after external authentication (e.g., 3D Secure). Required if `confirm` is `true` and payment method requires redirection.

• descriptionstring

  Arbitrary string for the PaymentIntent, displayed in Stripe dashboard and may be shown to customers.

• off_sessionboolean

  Indicates if customer is absent (off-session, e.g., for renewals). If `true`, `payment_method` must be provided and `confirm` must be `true`.

• receipt_emailstring

  Email address for receipt; if specified in live mode, receipt sent regardless of account email settings.

• payment_methodstring

  ID of PaymentMethod, Card, or compatible Source to attach. Required if `confirm` is `true` and `automatic_payment_methods` is not enabled, or if `off_session` is `true`.

• setup_future_usagestring

  Indicates intent to save payment method for future use: 'on_session' (customer present) or 'off_session' (customer absent).

• payment_method_typesstring[]

  List of payment method types (e.g., 'card', 'alipay') this PaymentIntent can use. Required if `automatic_payment_methods` is disabled.

• statement_descriptorstring

  String on customer's card statement (max 22 chars; no '<', '>', '"', "'"). Used as prefix if `statement_descriptor_suffix` is set.

• application_fee_amountinteger

  Application fee (smallest currency unit) for the application owner. Requires platform authentication and `Stripe-Account` header for the connected account.

• payment_method_optionsobject

  Payment-method-specific configuration for this PaymentIntent.

• automatic_payment_methodsobject

  Settings to configure compatible payment methods from the Stripe Dashboard. If disabled, `payment_method_types` must be provided.

• statement_descriptor_suffixstring

  Dynamic suffix for card statement (max 22 chars; no '<', '>', '"', "'"). Appended to main descriptor or account's default.

Parámetros de salida

• dataobjectObligatorio

  Complete PaymentIntent object from Stripe, including status, amount, currency, client_secret, and other details.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• tiersobject[]

  A list of pricing tiers. Required if `billing_scheme` is 'tiered'.

• activeboolean

  Whether the price can be used for new purchases. Defaults to true.

• productstring

  The ID of the product this price is for. Required if `product_data` is not provided.

• currencystringObligatorio

  Three-letter ISO currency code (e.g., 'usd', 'eur'). Must be a supported currency.

• metadataobject

  A set of key-value pairs to store additional information about the price.

• nicknamestring

  A brief, internal-facing description of the price. Useful for distinguishing prices in listings.

• recurringobject

  Specifies recurring components of a price, such as billing interval and usage type.

• lookup_keystring

  A unique, user-defined key to retrieve this price. Case-sensitive.

• tiers_modestring

  Defines how the quantity is applied to the tiers. Either 'graduated' (price is sum of costs from applicable tiers) or 'volume' (price is determined by the tier corresponding to the total quantity). Required if `billing_scheme` is 'tiered'.

• unit_amountinteger

  The base charge amount in the smallest currency unit (e.g., cents for USD). Required if not using `tiers`, `custom_unit_amount`, or `currency_options` with a unit amount for the primary currency.

• product_dataobject

  Fields for creating a new product if a `product` ID is not provided with the price.

• tax_behaviorstring

  Specifies how tax is applied to the price. Options are 'inclusive' (tax is included), 'exclusive' (tax is added), or 'unspecified'.

• billing_schemestring

  Describes how to compute the price per period. Either 'per_unit' (default, for fixed price per unit) or 'tiered' (for volume-based or graduated tiers).

• currency_optionsobject

  Prices defined in each supported currency. Useful for multi-currency pricing. The primary `currency`'s pricing can also be defined here.

• custom_unit_amountobject

  Configuration for a price where the unit amount is set by the customer at checkout.

• transform_quantityobject

  Contains information about how the quantity should be transformed before calculating the price.

• transfer_lookup_keyboolean

  If `true`, allows this price to overwrite an existing price with the same `lookup_key`. Defaults to `false`.

• unit_amount_decimalstring

  Same as `unit_amount`, but accepts a decimal string with up to 12 decimal places for higher precision. Required if not using `tiers`, `custom_unit_amount`, or `currency_options` with a unit amount for the primary currency and `unit_amount` is not provided.

Parámetros de salida

• dataobjectObligatorio

  The full JSON response from Stripe API representing the created price object.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstring

  Optional unique product identifier. Stripe generates one if omitted. Useful for idempotency or migrating existing IDs.

• urlstring

  Publicly accessible URL for the product's webpage or landing page.

• namestringObligatorio

  Product's name, displayed to customers.

• activeboolean

  Indicates if the product is available for purchase. Set to `false` to archive.

• imagesstring[]

  Up to 8 image URLs for display on product pages or checkout.

• metadataobject

  Key-value pairs for storing additional structured information.

• tax_codestring

  Stripe tax code ID for determining tax rates on sales.

• shippableboolean

  Indicates if the product is a physical good requiring shipping.

• unit_labelstring

  Label for product units to clarify quantity-based pricing.

• descriptionstring

  Product description, displayed to customers, providing more details.

• custom_fieldsobject[]

  Custom fields displayed on invoices for sales (e.g., PO numbers).

• shipping_costobject

  Defines the shipping cost for the product, either by referencing an existing shipping rate or creating a new one.

• default_price_dataobject

  Data used to create a new Price object as the default price for this product.

• marketing_featuresobject[]

  List of marketing features; short, benefit-oriented statements for pricing pages.

• package_dimensionsobject

  The dimensions of the product for shipping purposes. Required if the product is shippable and you use a shipping rate that calculates shipping costs based on dimensions.

• statement_descriptorstring

  String (max 22 chars) for customer credit card statements for charge recognition.

Parámetros de salida

• dataobjectObligatorio

  Full JSON response from Stripe API representing the created product.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• amountinteger

  Amount in smallest currency unit (e.g., 1000 for $10.00 USD) to refund. If omitted, a full refund is issued. Cannot exceed the charge's remaining refundable amount.

• chargestring

  Identifier of the charge to refund. Required if `payment_intent` is not provided.

• reasonstring

  Specifies the reason for the refund (e.g., `duplicate`, `fraudulent`, or `requested_by_customer`).

• metadataobject

  Key-value pairs to attach to the refund, for storing structured information like order numbers or internal IDs.

• payment_intentstring

  Identifier of the PaymentIntent to refund. Required if `charge` is not provided.

• reverse_transferboolean

  Reverse an associated transfer? Reversal is proportional to refund amount. Applies if the original charge had a reversible transfer.

• refund_application_feeboolean

  Refund the application fee? If true, full refunds refund the entire fee; partials refund proportionally. Applies if the original charge had an application fee.

Parámetros de salida

• dataobjectObligatorio

  The full Stripe Refund object detailing the created refund.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• itemsobject[]Obligatorio

  List of items (products/services and pricing) for the subscription.

• currencystring

  Three-letter ISO currency code (lowercase) for the subscription.

• customerstringObligatorio

  ID of the existing Stripe customer.

• metadataobject

  Key-value pairs for additional information about the subscription.

• cancel_atinteger

  Unix timestamp to schedule subscription cancellation.

• discountsobject[]

  List of discounts for the entire subscription.

• trial_endinteger

  Unix timestamp for trial end (can be 'now'). Overrides plan trial period.

• descriptionstring

  Arbitrary string describing the subscription.

• off_sessionboolean

  Allow initial payment attempt off-session (without direct customer interaction).

• on_behalf_ofstring

  Stripe Connect account ID for attributing payments (if charging on behalf of).

• automatic_taxobject

  Settings for Stripe's automatic tax calculation.

• transfer_dataobject

  Data to specify a funds transfer to a connected Stripe account as part of this subscription.

• days_until_dueinteger

  Days until invoice is due (for `send_invoice` collection method).

• default_sourcestring

  ID of default payment source (deprecated; use `default_payment_method`).

• promotion_codestring

  ID of the promotion code to apply.

• trial_settingsobject

  Settings related to the subscription's trial period, specifically how it should end.

• trial_from_planboolean

  Inherit trial period from the plan of the first item.

• invoice_settingsobject

  Custom settings for invoices generated for this subscription.

• payment_behaviorstringenum

  Behavior when initial payment fails or requires SCA.

  allow_incompletedefault_incompleteerror_if_incompletepending_if_incomplete
• payment_settingsobject

  Advanced payment settings for the subscription, including payment method options.

• add_invoice_itemsobject[]

  One-time invoice items for the first invoice.

• collection_methodstringenum

  How to collect payment (e.g., `charge_automatically`, `send_invoice`).

  charge_automaticallysend_invoice
• default_tax_ratesstring[]

  List of default tax rate IDs, overridable at item level.

• trial_period_daysinteger

  Number of days for the trial period.

• billing_thresholdsobject

  Subscription-level billing thresholds for metered billing.

• proration_behaviorstringenum

  How to handle prorations on subscription changes.

  always_invoicecreate_prorationsnone
• backdate_start_dateinteger

  Unix timestamp to backdate the subscription's start.

• billing_cycle_anchorinteger

  Unix timestamp to anchor the subscription's billing cycle.

• cancel_at_period_endboolean

  Cancel the subscription at the end of the current billing period.

• default_payment_methodstring

  ID of the default payment method for this subscription (must be attached to customer).

• application_fee_percentnumber

  Percentage (0-100) of subscription amount as an application fee for the platform.

• billing_cycle_anchor_configobject

  Configure the billing cycle anchor using a specific day, hour, minute, etc.

• pending_invoice_item_intervalobject

  Configuration for generating pending invoice items for usage-based billing.

Parámetros de salida

• dataobjectObligatorio

  Full JSON response from Stripe API for the created subscription.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• customer_idstringObligatorio

  The ID of the customer to delete. Must start with 'cus_' followed by alphanumeric characters.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• limitinteger

  Maximum number of charges to return (1-100, default is 10 if not specified).

• createdobject

  Filters charges by creation date using a dictionary with keys like 'gt', 'gte', 'lt', 'lte' and Unix timestamp values.

• customerstring

  Filters charges by the specified customer ID.

• ending_beforestring

  Object ID for pagination; fetches the previous page of charges relative to this cursor.

• payment_intentstring

  Filters charges by the specified PaymentIntent ID.

• starting_afterstring

  Object ID for pagination; fetches the next page of charges relative to this cursor.

• transfer_groupstring

  Filters charges by the specified transfer group ID.

Parámetros de salida

• dataobject[]Obligatorio

  List of charge objects matching the query parameters.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• limitinteger

  Maximum number of coupon objects to return. Stripe's default (usually 10) applies if omitted.

• ending_beforestring

  A coupon ID for pagination. Returns items created before this object.

• starting_afterstring

  A coupon ID for pagination. Returns items created after this object.

Parámetros de salida

• urlstringObligatorio

  API URL of the retrieved list, typically `/v1/coupons`.

• dataobject[]Obligatorio

  Array of `CouponData` objects. Empty if no coupons match or exist.

• errorstring

  Error if any occurred during the execution of the action

• objectstringObligatorio

  Object type; always 'list' for a list of coupons.

• has_morebooleanObligatorio

  `true` if more coupon objects are available via pagination.

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• typestring

  Filters the list by payment method type (e.g., 'card', 'sepa_debit').

• limitinteger

  Limit on the number of payment methods returned. If not specified, Stripe's default limit (typically 10) applies.

• customer_idstringObligatorio

  The unique identifier of the customer whose payment methods are to be retrieved.

• ending_beforestring

  Pagination cursor; ID of the first object from a previous request to fetch the preceding page.

• starting_afterstring

  Pagination cursor; ID of the last object from a previous request to fetch the next page.

Parámetros de salida

• urlstringObligatorio

  The URL of the API endpoint that was requested to retrieve this list of payment methods.

• dataarrayObligatorio

  An array of PaymentMethod objects that are attached to the specified customer and match the filter criteria. The list will be empty if the customer has no payment methods or if the filters result in no matches.

• errorstring

  Error if any occurred during the execution of the action

• objectstring

  String indicating the type of object. For this response, the value is consistently 'list'.

• has_morebooleanObligatorio

  True if this list of payment methods is part of a larger set and there are more items to retrieve. If true, the `id` of the last payment method in the `data` array can be used as the `starting_after` parameter in a subsequent request to fetch the next page.

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• emailstring

  Filters customers by a case-sensitive email address.

• limitinteger

  Maximum number of customer objects to return (range 1-100). Defaults to 10 if unspecified.

• createdobject

  Filters by creation date. Use a dictionary with keys like 'gte', 'lte', 'gt', 'lt' and Unix timestamp values (e.g., {'gte': 1609459200, 'lte': 1640995200}).

• test_clockstring

  Filters customers by the specified test clock ID. If omitted, returns only live mode customers.

• ending_beforestring

  Pagination cursor; retrieves objects created before the specified object ID to fetch the previous page.

• starting_afterstring

  Pagination cursor; retrieves objects created after the specified object ID to fetch the next page.

Parámetros de salida

• dataobject[]Obligatorio

  A list of customer objects matching the filter criteria, each represented as a dictionary.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• limitinteger

  Maximum number of invoice objects to return (1-100). Defaults to 10 if not specified.

• statusstring

  Filter invoices by status: 'draft', 'open', 'paid', 'uncollectible', or 'void'; if omitted, returns invoices with any status.

• createdobject

  Filter invoices by their creation date. Use keys like 'gt' (greater than), 'gte' (greater than or equal to), 'lt' (less than), 'lte' (less than or equal to) with Unix timestamp values to specify a range.

• customerstring

  ID of the customer whose invoices to retrieve; if omitted, invoices for all customers may be returned.

• subscriptionstring

  ID of the subscription whose invoices to retrieve; if omitted, invoices for all subscriptions may be returned.

• ending_beforestring

  Cursor for backward pagination; an invoice ID from a previous response that defines the end of the current page, used to fetch the preceding page.

• starting_afterstring

  Cursor for forward pagination; an invoice ID from a previous response that defines the end of the current page, used to fetch the subsequent page.

• collection_methodstring

  Filter by collection method: 'charge_automatically' (Stripe attempts auto-charge) or 'send_invoice' (Stripe emails invoice); if omitted, returns invoices with any collection method.

Parámetros de salida

• dataobject[]Obligatorio

  List of retrieved invoice objects; empty if no invoices match the filter criteria.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• limitinteger

  Maximum number of PaymentIntents to return (1-100, inclusive). Stripe defaults to 10 if not provided.

• createdobject

  Filter by creation date using Unix timestamps. Accepted keys: 'gte', 'lte', 'gt', 'lt'.

• customerstring

  ID of the customer to filter PaymentIntents by.

• ending_beforestring

  Cursor for paginating backwards, typically a PaymentIntent ID, to fetch the previous page.

• starting_afterstring

  Cursor for paginating forwards, typically a PaymentIntent ID, to fetch the next page.

Parámetros de salida

• dataobject[]Obligatorio

  A list of PaymentIntent objects retrieved from Stripe, conforming to the specified query parameters. Each object in the list is a dictionary representing a PaymentIntent.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• limitinteger

  Maximum number of items to return (1-100, inclusive). Stripe API defaults to 10 if omitted.

• activeboolean

  Filter by active status. `true` for active, `false` for inactive.

• ending_beforestring

  Object ID for backward pagination; retrieves items created before this ID.

• starting_afterstring

  Object ID for forward pagination; retrieves items created after this ID.

Parámetros de salida

• dataobject[]Obligatorio

  List of payment link objects.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idsstring[]

  A list of product IDs to retrieve. If provided, only products with these specific IDs will be returned.

• urlstring

  Filter products by a specific URL. Only products with this exact URL will be returned.

• limitinteger

  A limit on the number of product objects to be returned. The value must be an integer between 1 and 100, inclusive. If not specified, the default is 10.

• activeboolean

  Filter products based on their active status. Set to `True` to return only active products, or `False` for inactive ones.

• createdobject

  Filters products by their creation date range. Provide a dictionary with keys like 'gt' (greater than), 'gte' (greater than or equal to), 'lt' (less than), or 'lte' (less than or equal to) and Unix timestamp values (seconds since epoch). For instance, `{'gte': 1609459200, 'lte': 1640995200}` filters for products created from January 1, 2021, to January 1, 2022.

• shippableboolean

  Filter products based on whether they are shippable. Set to `True` to return only shippable products, or `False` for non-shippable ones.

• ending_beforestring

  A cursor for use in pagination to fetch the previous page of results. `ending_before` is an object ID that defines your place in the list. For instance, if a list request returns objects ending with `prod_XYZ`, your subsequent call can include `ending_before='prod_XYZ'` to fetch the previous page.

• starting_afterstring

  A cursor for use in pagination to fetch the next page of results. `starting_after` is an object ID that defines your place in the list. For instance, if a list request returns objects and the last object's ID is `prod_ABC`, your subsequent call can include `starting_after='prod_ABC'` to fetch the next page.

Parámetros de salida

• dataobject[]Obligatorio

  A list of product objects matching the query criteria. Each object in the list is a dictionary representing a Stripe product. If no products match, an empty list is returned.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• limitinteger

  Limit on the number of refunds to be returned. Stripe API defaults to 10 if unspecified.

• chargestring

  Filters refunds to those for the specified Charge ID.

• ending_beforestring

  A cursor for pagination; returns only refunds created before this object ID.

• payment_intentstring

  Filters refunds to those for the specified PaymentIntent ID.

• starting_afterstring

  A cursor for pagination; returns only refunds created after this object ID.

Parámetros de salida

• urlstringObligatorio

  The API URL endpoint from which this list of refunds was fetched.

• dataobject[]Obligatorio

  A list of refund objects matching the query criteria, ordered by creation date in descending order.

• errorstring

  Error if any occurred during the execution of the action

• objectstringObligatorio

  String representing the object's type. Always 'list' for this response.

• has_morebooleanObligatorio

  A boolean flag indicating whether there are more refunds available beyond the current list. If true, use the ID of the last refund in the 'data' array as the 'starting_after' parameter in a subsequent request to fetch the next page.

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• limitinteger

  A limit on the number of objects to be returned. The Stripe API defaults to 10 if not provided; value must be between 1 and 100.

• activeboolean

  A filter on the list based on the object’s `active` field. If true, only active shipping rates are returned. If false, only inactive shipping rates are returned.

• createdobject

  A filter on the list based on the object’s `created` field. This can be a Unix timestamp (integer) or a dictionary with the following options for ranged queries: `gt` (greater than), `gte` (greater than or equal to), `lt` (less than), `lte` (less than or equal to). Example for a ranged query: `{"gte": 1609459200}` for rates created on or after Jan 1, 2021 UTC.

• currencystring

  Only return shipping rates for the given three-letter ISO currency code (e.g., `usd`), in lowercase. Must be a 3-letter ISO code.

• ending_beforestring

  A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `sr_foo`, your subsequent call can include `ending_before=sr_foo` in order to fetch the previous page of the list.

• starting_afterstring

  A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `sr_foo`, your subsequent call can include `starting_after=sr_foo` in order to fetch the next page of the list.

Parámetros de salida

• urlstringObligatorio

  The URL for accessing this list of shipping rates.

• dataobject[]Obligatorio

  A list of shipping rate objects matching the query.

• errorstring

  Error if any occurred during the execution of the action

• objectstringObligatorio

  String representing the object's type. Objects of the same type share the same value. Always `list` for this response.

• has_morebooleanObligatorio

  True if this list has more pages of items after this page, false otherwise.

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• limitinteger

  Limit on the number of subscription objects to return (1-100). Default is 10.

• pricestring

  ID of the recurring price to filter subscriptions by.

• statusstring

  Filter subscriptions by status (e.g., 'active', 'all', 'canceled'). Defaults to non-canceled statuses if unspecified.

• createdobject

  Filter subscriptions by creation date using comparison keys (e.g., 'gte', 'lt') and Unix timestamp values.

• customerstring

  ID of the customer whose subscriptions will be retrieved.

• test_clockstring

  Filter subscriptions by a specific test clock ID (only applicable in test mode).

• automatic_taxobject

  Filter subscriptions by automatic tax settings, e.g., {'enabled': True}.

• ending_beforestring

  Cursor for paginating backwards; provide the ID of the subscription that should end the list.

• starting_afterstring

  Cursor for paginating forwards; provide the ID of the subscription that should start the list.

• collection_methodstring

  Filter subscriptions by collection method: 'charge_automatically' or 'send_invoice'.

• current_period_endobject

  Filter subscriptions by the end date of the current billing period, using comparison keys (e.g., 'gt', 'gte') and Unix timestamp values.

• current_period_startobject

  Filter subscriptions by the start date of the current billing period, using comparison keys (e.g., 'lt', 'lte') and Unix timestamp values.

Parámetros de salida

• dataobject[]Obligatorio

  A list of subscription objects from Stripe, matching the query.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• limitinteger

  Maximum number of objects to return. API defaults to 10 if this parameter is omitted.

• ending_beforestring

  Object ID cursor to fetch the previous page of results.

• starting_afterstring

  Object ID cursor to fetch the next page of results.

Parámetros de salida

• urlstringObligatorio

  The API endpoint URL used to retrieve this list.

• dataobject[]Obligatorio

  List of tax code objects; empty if none are available.

• errorstring

  Error if any occurred during the execution of the action

• objectstringObligatorio

  Object's type, consistently `list`.

• has_morebooleanObligatorio

  Indicates if more tax codes are available. If true, use the ID of the last item with `starting_after` to fetch the next page.

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• limitinteger

  A limit on the number of tax rates to be returned. The value must be between 1 and 100, inclusive. The default is 10.

• activeboolean

  Filter tax rates by their active status. Set to `true` for active tax rates and `false` for inactive (archived) tax rates.

• createdobject

  Filter tax rates by their creation date. Accepts a dictionary with keys like `gt` (greater than), `gte` (greater than or equal to), `lt` (less than), or `lte` (less than or equal to), and Unix timestamp values.

• inclusiveboolean

  Filter tax rates by whether they are inclusive. Set to `true` for inclusive tax rates and `false` for exclusive tax rates.

• ending_beforestring

  A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `ending_before=obj_foo` in order to fetch the previous page of objects.

• starting_afterstring

  A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `starting_after=obj_bar` in order to fetch the next page of objects.

Parámetros de salida

• urlstringObligatorio

  The URL for this list of tax rates. This can be used to fetch the current page directly.

• dataobject[]Obligatorio

  A list of tax rate objects that match the specified criteria.

• errorstring

  Error if any occurred during the execution of the action

• objectstringObligatorio

  String representing the object's type. For a list of tax rates, this is typically `list`.

• has_morebooleanObligatorio

  A boolean value indicating whether there are more tax rates available in the list beyond the current page. `true` if there are more items, `false` otherwise.

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  Detailed Stripe account balance object. Includes breakdowns of 'available' and 'pending' funds by currency/source types. Key details: 'object' (type, e.g., 'balance'), 'available' (immediately usable funds), 'pending' (funds not yet available), 'livemode' (live/test mode status).

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• charge_idstringObligatorio

  Identifier for the charge, typically starting with 'ch_'.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• customer_idstringObligatorio

  The unique identifier of the Stripe customer to retrieve. This ID typically starts with 'cus_'.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the full Stripe customer object as returned by the API.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• client_secretstring

  Client secret for the PaymentIntent. Required if using a publishable key for authentication.

• payment_intent_idstringObligatorio

  The unique identifier of the PaymentIntent to retrieve.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• refund_idstringObligatorio

  The unique identifier of the refund to retrieve. This ID typically starts with 're_'.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• subscription_idstringObligatorio

  Unique identifier of the Stripe subscription to retrieve, typically starting with 'sub_'.

Parámetros de salida

• dataobjectObligatorio

  Complete Stripe subscription object from the API, including details like status, items, customer, and current billing period.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• pagestring

  Pagination cursor for a specific page; omit for the first page. Use `next_page` from a previous response for subsequent pages.

• limitinteger

  Maximum number of results per page (default is 10).

• querystringObligatorio

  The search query string, adhering to Stripe's Search Query Language. This language supports features like exact matches, range queries, boolean operators, and searching by metadata. For detailed syntax, refer to https://docs.stripe.com/search#search-query-language.

Parámetros de salida

• urlstringObligatorio

  The API URL that can be used to re-fetch this specific list of search results.

• dataarrayObligatorio

  List of customer objects matching the search query.

• errorstring

  Error if any occurred during the execution of the action

• objectstring

  Indicates the type of object returned. For customer search results, this will always be 'search_result'.

• has_morebooleanObligatorio

  Indicates if more search results are available.

• next_pagestring

  Pagination cursor for the next page, if `has_more` is true. Use in the `page` parameter of a subsequent request.

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• taxobject

  Specifies tax-related information for the customer.

• namestring

  The customer's full name or the business name.

• emailstringemail

  The customer's email address. Updating this may trigger a verification email to the new address.

• phonestring

  The customer's primary phone number, preferably in E.164 format.

• couponstring

  The ID of a coupon to apply to the customer. This coupon will be applied to the customer's subsequent invoices and subscriptions.

• addressobject

  Defines the customer's primary billing address.

• balanceinteger

  An integer representing the customer's account balance in the smallest currency unit (e.g., cents for USD). A positive value credits the customer's balance, and a negative value debits it. This balance will be applied to future invoices.

• metadataobject

  Key-value pairs for storing additional, unstructured information. Keys up to 40 characters, values up to 500.

• shippingobject

  Encapsulates the customer's shipping details.

• tax_exemptstring

  Specifies the customer's tax exemption status. Accepted values are 'none', 'exempt', or 'reverse'. Use 'reverse' for B2B transactions in the EU subject to reverse charge.

• customer_idstringObligatorio

  The unique identifier of the Stripe customer to update.

• descriptionstring

  An arbitrary string providing additional information about the customer, often used for internal notes. Maximum 5000 characters.

• default_sourcestring

  The ID of a card or bank account object to set as the customer's default payment source for charges and subscriptions. Deprecated in favor of `default_payment_method` for newer integrations.

• invoice_settingsobject

  Defines default settings for invoices created for this customer.

• default_payment_methodstring

  The ID of a PaymentMethod to set as the customer's default for subscriptions and invoices.

Parámetros de salida

• dataobjectObligatorio

  The complete Stripe customer object reflecting the updates, returned as a dictionary.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• amountinteger

  The amount intended to be collected by this PaymentIntent, in the smallest currency unit (e.g., cents for USD). This is a positive integer.

• currencystring

  The three-letter ISO currency code, in lowercase (e.g., 'usd', 'eur'). Must be a supported currency.

• customerstring

  The ID of the Customer this PaymentIntent should be associated with.

• metadataobject

  A set of key-value pairs to store additional structured information about the PaymentIntent. Keys can be up to 40 characters long and values can be up to 500 characters long.

• shippingobject

  Shipping information for the PaymentIntent. This is a dictionary that should contain the recipient's `name`, `phone`, and an `address` object with `line1`, `line2` (optional), `city`, `state`, `postal_code`, and `country`.

• descriptionstring

  An arbitrary string providing a description of the PaymentIntent, often displayed to users.

• receipt_emailstring

  The email address to which Stripe will send a receipt for a successful payment.

• payment_methodstring

  ID of the PaymentMethod to attach to this PaymentIntent.

• payment_intent_idstringObligatorio

  The unique identifier of the PaymentIntent to be updated.

• setup_future_usagestring

  Indicates if you intend to use the payment method attached to this PaymentIntent for future payments. Allowed values are 'on_session' or 'off_session'.

• statement_descriptorstring

  String for customer's credit card statement (max 22 characters).

• statement_descriptor_suffixstring

  Additional info for customer's card statement, appended to `statement_descriptor` (max 22 characters).

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• itemsobject[]

  List of subscription item updates (max 20). Item `id` usually required for modification.

• metadataobject

  Key-value pairs for custom information (max 50 keys: 40 chars; values: 500 chars). Replaces existing; empty dict removes all.

• descriptionstring

  Arbitrary string for user display or internal tracking.

• automatic_taxobject

  Stripe Tax settings for automatic tax calculation. `liability` may be required if `enabled` is true.

• subscription_idstringObligatorio

  Unique identifier of the subscription to update.

• payment_behaviorstring

  Payment handling for invoices (especially initial): 'allow_incomplete' (creates subscription if first payment fails), 'error_if_incomplete' (fails request if initial payment required and fails), 'pending_if_incomplete' (sets to pending if payment fails).

• collection_methodstring

  How invoices are paid: 'charge_automatically' (charges default payment method) or 'send_invoice' (emails invoice for manual payment).

• proration_behaviorstring

  How to handle prorations on changes: 'create_prorations' (creates prorated charges/credits), 'none' (no prorations), or 'always_invoice' (creates and invoices prorations immediately).

• billing_cycle_anchorinteger

  Unix timestamp (seconds) or 'now' to anchor billing cycle and renewal. Changes may cause proration.

• cancel_at_period_endboolean

  If true, schedules cancellation at current period's end; if false, undoes scheduled cancellation.

• default_payment_methodstring

  ID of the default payment method; updates subscription's default payment source if provided.

Parámetros de salida

• dataobjectObligatorio

  Complete Stripe API JSON response: the fully updated subscription object.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not