Use Stripe 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.
Manage payment intents, customers, subscriptions, invoices, charges, products, prices, and events. Supported Stripe events can start workflows.
Create a new Payment Intent to process a payment
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) amountnumber Yes Amount in the currency’s smallest unit (e.g., 2000 for 20.00 USD) currencystring Yes Three-letter ISO currency code (e.g., usd, eur) customerstring No Customer ID to associate with this payment payment_methodstring No Payment method ID descriptionstring No Description of the payment receipt_emailstring No Email address to send receipt to metadatajson No Set of key-value pairs for storing additional information automatic_payment_methodsjson No Enable automatic payment methods (e.g., {"enabled": true})
Parameter Type Description payment_intentobject 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 metadatajson 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)
Retrieve an existing Payment Intent by ID
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) idstring Yes Payment Intent ID (e.g., pi_1234567890)
Parameter Type Description payment_intentobject 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 metadatajson 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)
Update an existing Payment Intent
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) idstring Yes Payment Intent ID (e.g., pi_1234567890) amountnumber No Updated amount in the currency’s smallest unit currencystring No Three-letter ISO currency code customerstring No Customer ID descriptionstring No Updated description metadatajson No Updated metadata
Parameter Type Description payment_intentobject 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 metadatajson 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)
Confirm a Payment Intent and inspect its resulting status. Confirmation can require further action or asynchronous processing before payment succeeds.
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) idstring Yes Payment Intent ID (e.g., pi_1234567890) payment_methodstring No Payment method ID to confirm with
Parameter Type Description payment_intentobject 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 metadatajson 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)
Capture an authorized Payment Intent
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) idstring Yes Payment Intent ID (e.g., pi_1234567890) amount_to_capturenumber No Amount to capture in the currency’s smallest unit (defaults to the full amount)
Parameter Type Description payment_intentobject 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 metadatajson 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)
Cancel a Payment Intent
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) idstring Yes Payment Intent ID (e.g., pi_1234567890) cancellation_reasonstring No Reason for cancellation (duplicate, fraudulent, requested_by_customer, abandoned)
Parameter Type Description payment_intentobject 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 metadatajson 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)
List all Payment Intents
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) limitnumber No Number of results to return (default 10, max 100) customerstring No Filter by customer ID createdjson No Filter by creation date (e.g., {"gt": 1633024800})
Parameter Type Description payment_intentsarray 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 metadatajson List metadata including count and has_more ↳ count number Number of items returned ↳ has_more boolean Whether more items exist beyond this page
Search for Payment Intents using query syntax
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) querystring Yes Search query (e.g., "status:'succeeded' AND currency:'usd'") limitnumber No Number of results to return (default 10, max 100)
Parameter Type Description payment_intentsarray 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 metadatajson Search metadata including count and has_more ↳ count number Number of items returned ↳ has_more boolean Whether more items exist beyond this page
Create a new customer object
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) emailstring No Customer email address namestring No Customer full name phonestring No Customer phone number descriptionstring No Description of the customer addressjson No Customer address object metadatajson No Set of key-value pairs payment_methodstring No Payment method ID to attach
Parameter Type Description customerobject 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 metadatajson Customer metadata ↳ id string Stripe unique identifier ↳ email string Customer email address ↳ name string Display name
Retrieve an existing customer by ID
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) idstring Yes Customer ID (e.g., cus_1234567890)
Parameter Type Description customerobject 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 metadatajson Customer metadata ↳ id string Stripe unique identifier ↳ email string Customer email address ↳ name string Display name
Update an existing customer
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) idstring Yes Customer ID (e.g., cus_1234567890) emailstring No Updated email address namestring No Updated name phonestring No Updated phone number descriptionstring No Updated description addressjson No Updated address object metadatajson No Updated metadata
Parameter Type Description customerobject 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 metadatajson Customer metadata ↳ id string Stripe unique identifier ↳ email string Customer email address ↳ name string Display name
Permanently delete a customer
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) idstring Yes Customer ID (e.g., cus_1234567890)
Parameter Type Description deletedboolean Whether the resource was deleted idstring ID of the deleted resource
List all customers
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) limitnumber No Number of results to return (default 10, max 100) emailstring No Filter by email address createdjson No Filter by creation date
Parameter Type Description customersarray 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 metadatajson List metadata ↳ count number Number of items returned ↳ has_more boolean Whether more items exist beyond this page
Search for customers using query syntax
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) querystring Yes Search query (e.g., "email:'customer@example.com '") limitnumber No Number of results to return (default 10, max 100)
Parameter Type Description customersarray 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 metadatajson Search metadata ↳ count number Number of items returned ↳ has_more boolean Whether more items exist beyond this page
Create a new subscription for a customer
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) customerstring Yes Customer ID to subscribe itemsjson Yes Array of items with price IDs (e.g., [{"price": "price_xxx", "quantity": 1}]) trial_period_daysnumber No Number of trial days default_payment_methodstring No Payment method ID cancel_at_period_endboolean No Cancel subscription at period end metadatajson No Set of key-value pairs for storing additional information
Parameter Type Description subscriptionobject 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 metadatajson Subscription metadata including ID, status, and customer ↳ id string Stripe unique identifier ↳ status string Current state of the resource ↳ customer string Associated customer ID
Retrieve an existing subscription by ID
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) idstring Yes Subscription ID (e.g., sub_1234567890)
Parameter Type Description subscriptionobject 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 metadatajson Subscription metadata including ID, status, and customer ↳ id string Stripe unique identifier ↳ status string Current state of the resource ↳ customer string Associated customer ID
Update an existing subscription
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) idstring Yes Subscription ID (e.g., sub_1234567890) itemsjson No Updated array of items with price IDs cancel_at_period_endboolean No Cancel subscription at period end metadatajson No Updated metadata
Parameter Type Description subscriptionobject 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 metadatajson Subscription metadata including ID, status, and customer ↳ id string Stripe unique identifier ↳ status string Current state of the resource ↳ customer string Associated customer ID
Cancel a subscription
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) idstring Yes Subscription ID (e.g., sub_1234567890) prorateboolean No Whether to prorate the cancellation invoice_nowboolean No Whether to invoice immediately
Parameter Type Description subscriptionobject 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 metadatajson Subscription metadata including ID, status, and customer ↳ id string Stripe unique identifier ↳ status string Current state of the resource ↳ customer string Associated customer ID
Resume a paused subscription
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) idstring Yes Subscription ID (e.g., sub_1234567890)
Parameter Type Description subscriptionobject 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 metadatajson Subscription metadata including ID, status, and customer ↳ id string Stripe unique identifier ↳ status string Current state of the resource ↳ customer string Associated customer ID
List one page of subscriptions. Follow starting_after while metadata.has_more is true.
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) limitnumber No Number of results to return (default 10, max 100) customerstring No Filter by customer ID statusstring No Filter by status (active, past_due, unpaid, canceled, incomplete, incomplete_expired, trialing, all) starting_afterstring No Next-page cursor: last subscription ID from the previous page. Do not combine with ending_before. ending_beforestring No Previous-page cursor: first subscription ID from the current page. Do not combine with starting_after. pricestring No Filter by price ID
Parameter Type Description subscriptionsarray 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 metadatajson List metadata ↳ count number Number of items returned ↳ has_more boolean Whether more items exist beyond this page
Search one page of subscriptions using query syntax. Pass metadata.next_page as page to continue.
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) querystring Yes Search query (e.g., "status:'active' AND metadata['order_id']:'6735'") pagestring No Pagination token from metadata.next_page. Omit for the first page and keep the same query. limitnumber No Number of results to return (default 10, max 100)
Parameter Type Description subscriptionsarray 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 metadatajson 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
Create a new invoice
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) customerstring Yes Customer ID (e.g., cus_1234567890) descriptionstring No Description of the invoice metadatajson No Set of key-value pairs auto_advanceboolean No Auto-finalize the invoice collection_methodstring No Collection method: charge_automatically or send_invoice
Parameter Type Description invoiceobject 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 metadatajson 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)
Retrieve an existing invoice by ID
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) idstring Yes Invoice ID (e.g., in_1234567890)
Parameter Type Description invoiceobject 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 metadatajson 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)
Update an existing invoice
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) idstring Yes Invoice ID (e.g., in_1234567890) descriptionstring No Description of the invoice metadatajson No Set of key-value pairs auto_advanceboolean No Auto-finalize the invoice
Parameter Type Description invoiceobject 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 metadatajson 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)
Permanently delete a draft invoice
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) idstring Yes Invoice ID (e.g., in_1234567890)
Parameter Type Description deletedboolean Whether the invoice was deleted idstring The ID of the deleted invoice
Finalize a draft invoice
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) idstring Yes Invoice ID (e.g., in_1234567890) auto_advanceboolean No Auto-advance the invoice
Parameter Type Description invoiceobject 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 metadatajson 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)
Pay an invoice
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) idstring Yes Invoice ID (e.g., in_1234567890) paid_out_of_bandboolean No Mark invoice as paid out of band
Parameter Type Description invoiceobject 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 metadatajson 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)
Void an invoice
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) idstring Yes Invoice ID (e.g., in_1234567890)
Parameter Type Description invoiceobject 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 metadatajson 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)
Send an invoice to the customer
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) idstring Yes Invoice ID (e.g., in_1234567890)
Parameter Type Description invoicejson The sent invoice object metadatajson 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)
List all invoices
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) limitnumber No Number of results to return (default 10, max 100) customerstring No Filter by customer ID statusstring No Filter by invoice status
Parameter Type Description invoicesjson Array of invoice objects metadatajson List metadata ↳ count number Number of items returned ↳ has_more boolean Whether more items exist beyond this page
Search for invoices using query syntax
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) querystring Yes Search query (e.g., "customer:'cus_1234567890'") limitnumber No Number of results to return (default 10, max 100)
Parameter Type Description invoicesjson Array of matching invoice objects metadatajson Search metadata ↳ count number Number of items returned ↳ has_more boolean Whether more items exist beyond this page
Create a new charge to process a payment
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) amountnumber Yes Amount in the currency’s smallest unit (e.g., 2000 for 20.00 USD) currencystring Yes Three-letter ISO currency code (e.g., usd, eur) customerstring No Customer ID to associate with this charge sourcestring No Payment source ID (e.g., card token or saved card ID) descriptionstring No Description of the charge metadatajson No Set of key-value pairs for storing additional information captureboolean No Whether to immediately capture the charge (defaults to true)
Parameter Type Description chargejson The created Charge object metadatajson 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
Retrieve an existing charge by ID
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) idstring Yes Charge ID (e.g., ch_1234567890)
Parameter Type Description chargejson The retrieved Charge object metadatajson 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
Update an existing charge
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) idstring Yes Charge ID (e.g., ch_1234567890) descriptionstring No Updated description metadatajson No Updated metadata
Parameter Type Description chargejson The updated Charge object metadatajson 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
Capture an uncaptured charge
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) idstring Yes Charge ID (e.g., ch_1234567890) amountnumber No Amount to capture in the currency’s smallest unit (defaults to the full amount)
Parameter Type Description chargejson The captured Charge object metadatajson 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
List all charges
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) limitnumber No Number of results to return (default 10, max 100) customerstring No Filter by customer ID createdjson No Filter by creation date (e.g., {"gt": 1633024800})
Parameter Type Description chargesjson Array of Charge objects metadatajson List metadata including count and has_more ↳ count number Number of items returned ↳ has_more boolean Whether more items exist beyond this page
Search for charges using query syntax
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) querystring Yes Search query (e.g., "status:'succeeded' AND currency:'usd'") limitnumber No Number of results to return (default 10, max 100)
Parameter Type Description chargesjson Array of matching Charge objects metadatajson Search metadata including count and has_more ↳ count number Number of items returned ↳ has_more boolean Whether more items exist beyond this page
Create a new product object
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) namestring Yes Product name descriptionstring No Product description activeboolean No Whether the product is active imagesjson No Array of image URLs for the product metadatajson No Set of key-value pairs
Parameter Type Description productjson The created product object metadatajson Product metadata ↳ id string Stripe unique identifier ↳ name string Display name ↳ active boolean Whether the resource is currently active
Retrieve an existing product by ID
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) idstring Yes Product ID (e.g., prod_1234567890)
Parameter Type Description productjson The retrieved product object metadatajson Product metadata ↳ id string Stripe unique identifier ↳ name string Display name ↳ active boolean Whether the resource is currently active
Update an existing product
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) idstring Yes Product ID (e.g., prod_1234567890) namestring No Updated product name descriptionstring No Updated product description activeboolean No Updated active status imagesjson No Updated array of image URLs metadatajson No Updated metadata
Parameter Type Description productjson The updated product object metadatajson Product metadata ↳ id string Stripe unique identifier ↳ name string Display name ↳ active boolean Whether the resource is currently active
Permanently delete a product
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) idstring Yes Product ID (e.g., prod_1234567890)
Parameter Type Description deletedboolean Whether the product was deleted idstring The ID of the deleted product
List all products
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) limitnumber No Number of results to return (default 10, max 100) activeboolean No Filter by active status
Parameter Type Description productsjson Array of product objects metadatajson List metadata ↳ count number Number of items returned ↳ has_more boolean Whether more items exist beyond this page
Search for products using query syntax
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) querystring Yes Search query (e.g., "name:'shirt'") limitnumber No Number of results to return (default 10, max 100)
Parameter Type Description productsjson Array of matching product objects metadatajson Search metadata ↳ count number Number of items returned ↳ has_more boolean Whether more items exist beyond this page
Create a new price for a product
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) productstring Yes Product ID (e.g., prod_1234567890) currencystring Yes Three-letter ISO currency code (e.g., usd, eur) unit_amountnumber No Amount in the currency’s smallest unit (e.g., 1000 for 10.00 USD) recurringjson No Recurring billing configuration (interval: day/week/month/year) metadatajson No Set of key-value pairs billing_schemestring No Billing scheme (per_unit or tiered)
Parameter Type Description pricejson The created price object metadatajson 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)
Retrieve an existing price by ID
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) idstring Yes Price ID (e.g., price_1234567890)
Parameter Type Description pricejson The retrieved price object metadatajson 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)
Update an existing price
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) idstring Yes Price ID (e.g., price_1234567890) activeboolean No Whether the price is active metadatajson No Updated metadata
Parameter Type Description pricejson The updated price object metadatajson 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)
List all prices
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) limitnumber No Number of results to return (default 10, max 100) productstring No Filter by product ID activeboolean No Filter by active status
Parameter Type Description pricesjson Array of price objects metadatajson List metadata ↳ count number Number of items returned ↳ has_more boolean Whether more items exist beyond this page
Search for prices using query syntax
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) querystring Yes Search query (e.g., "active:'true' AND currency:'usd'") limitnumber No Number of results to return (default 10, max 100)
Parameter Type Description pricesjson Array of matching price objects metadatajson Search metadata ↳ count number Number of items returned ↳ has_more boolean Whether more items exist beyond this page
Retrieve an existing Event by ID
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) idstring Yes Event ID (e.g., evt_1234567890)
Parameter Type Description eventjson The retrieved Event object metadatajson Event metadata including ID, type, and created timestamp ↳ id string Stripe unique identifier ↳ type string Event type identifier ↳ created number Unix timestamp of creation
List all Events
Parameter Type Required Description apiKeystring Yes Stripe API key (secret key) limitnumber No Number of results to return (default 10, max 100) typestring No Filter by event type (e.g., payment_intent.created) createdjson No Filter by creation date (e.g., {"gt": 1633024800})
Parameter Type Description eventsjson Array of Event objects metadatajson List metadata including count and has_more ↳ count number Number of items returned ↳ has_more boolean Whether more items exist beyond this page
A trigger starts a workflow when a supported event occurs in this service.
Triggers when Stripe events occur (payments, subscriptions, invoices, etc.)
Parameter Type Required Description eventTypesstring No Select specific Stripe events to filter. Leave empty to receive all events from Stripe. webhookSecretstring No Your webhook signing secret from Stripe Dashboard. Used to verify webhook authenticity.
Parameter Type Description idstring Unique identifier for the event typestring Event type (e.g., payment_intent.succeeded, customer.created, invoice.paid) objectstring Always "event" api_versionstring Stripe API version used to render the event creatednumber Unix timestamp when the event was created datajson Event data containing the affected Stripe object. Structure varies by event type - access via data.object for the resource (PaymentIntent, Customer, Invoice, etc.) livemodeboolean Whether this event occurred in live mode (true) or test mode (false) pending_webhooksnumber Number of webhooks yet to be delivered for this event requestjson Information about the API request that triggered this event (id, idempotency_key)