Stripe

Stripe is a financial technology company that provides infrastructure for handling online payments. It allows businesses to accept payments, manage recurring billing, and send payouts to bank accounts in different countries. Founded in 2010, Stripe has become a widely used solution for developers and companies building e-commerce platforms, marketplaces, or software services.

The Stripe API is central to its platform. It is a set of well-documented interfaces that let developers integrate payment functionality directly into websites and applications. The API supports common operations like charging credit cards, storing customer information securely, and managing subscriptions. It also handles more complex tasks, such as dealing with multiple currencies, supporting digital wallets, and complying with regulatory requirements. Stripe’s design emphasizes clarity and consistency, making it accessible for developers while scalable enough for large systems. In practice, it serves as a flexible toolkit for building custom payment workflows without reinventing core financial processes.

Documentation URL: https://docs.stripe.com/api

Installable Elements              (No items selected)



Base Elements

These elements are required for the templates below to work

  • Remote Site Setting enabling access to the API base URL

Account Sessions

Templates related to Account Sessions

  • Creates a AccountSession object that includes a single-use token that the platform can use on their front-end to grant client-side API access.

Accounts

Templates related to Accounts

  • Creates an AccountLink object that includes a single-use Stripe URL that the platform can redirect their user to in order to take them through the Connect Onboarding flow.

  • Returns a list of accounts connected to your platform via Connect. If you’re not a platform, the list is empty.

  • With Connect, you can create Stripe accounts for your users.

  • With Connect, you can delete accounts you manage.

  • Retrieves the details of an account.

  • Updates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged.

  • Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.

  • Retrieves information about the specified Account Capability.

  • Updates an existing Account Capability. Request or remove a capability by updating its requested parameter.

  • List external accounts for an account.

  • Create an external account for a given account.

  • Delete a specified external account for a given account.

  • Retrieve a specified external account for a given account.

  • Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency.

  • Creates a single-use login link for an Express account to access their Stripe dashboard.

  • With Connect, you may flag accounts as suspicious.

Active Entitlements

Templates related to Active Entitlements

  • Retrieve a list of active entitlements for a customer

  • Retrieve an active entitlement

Application Fee Refunds

Templates related to Application Fee Refunds

  • null

  • You can see a list of the refunds belonging to a specific application fee. Note that the 10 most recent refunds are always available by default on the application fee object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional refunds.

  • Refunds an application fee that has previously been collected but not yet refunded.

Application Fees

Templates related to Application Fees

  • Returns a list of application fees you’ve previously collected. The application fees are returned in sorted order, with the most recent fees appearing first.

  • By default, you can see the 10 most recent refunds stored directly on the application fee object, but you can also retrieve details about a specific refund stored on the application fee.

  • Updates the specified application fee refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

  • Retrieves the details of an application fee that your account has collected. The same information is returned when refunding the application fee.

Balance

Templates related to Balance

  • Retrieves the current account balance, based on the authentication that was used to make the request.

Balance Transactions

Templates related to Balance Transactions

  • Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

  • Retrieves the balance transaction with the given ID.

Billing Meter Event Adjustments

Templates related to Billing Meter Event Adjustments

  • Creates a billing meter event adjustment

Billing Meter Event Summaries

Templates related to Billing Meter Event Summaries

  • Retrieve a list of billing meter event summaries.

Billing Meter Events

Templates related to Billing Meter Events

  • Creates a billing meter event

Billing Meters

Templates related to Billing Meters

  • Retrieve a list of billing meters.

  • Creates a billing meter

  • Retrieves a billing meter given an ID

  • Updates a billing meter

  • Deactivates a billing meter

  • Reactivates a billing meter

Charges

Templates related to Charges

  • Returns a list of charges you’ve previously created. The charges are returned in sorted order, with the most recent charges appearing first.

  • This method is no longer recommended—use the Payment Intents API to initiate a new payment instead.

  • Search for charges you’ve previously created using Stripe’s Search Query Language.

  • Retrieves the details of a charge that has previously been created. Supply the unique charge ID that was returned from your previous request, and Stripe will return the corresponding charge information. The same information is returned when creating or refunding the charge.

  • Updates the specified charge by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

  • Capture the payment of an existing, uncaptured charge that was created with the capture option set to false.

Checkout

Templates related to Checkout

  • Returns a list of Checkout Sessions.

  • Creates a Session object.

  • Retrieves a Session object.

  • A Session can be expired when it is in one of these statuses: open

  • When retrieving a Checkout Session, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

Climate Order

Templates related to Climate Order

  • Lists all Climate order objects. The orders are returned sorted by creation date, with the most recently created orders appearing first.

  • Creates a Climate order object for a given Climate product. The order will be processed immediately after creation and payment will be deducted your Stripe balance.

  • Retrieves the details of a Climate order object with the given ID.

  • Updates the specified order by setting the values of the parameters passed.

  • Cancels a Climate order. You can cancel an order within 30 days of creation. Stripe refunds the reservation amount_subtotal, but not the amount_fees for user-triggered cancellations.

Climate Products

Templates related to Climate Products

  • Lists all available Climate product objects.

  • Retrieves the details of a Climate product with the given ID.

Climate Suppliers

Templates related to Climate Suppliers

  • Lists all available Climate supplier objects.

  • Retrieves a Climate supplier object.

Confirmation Tokens

Templates related to Confirmation Tokens

  • Retrieves an existing ConfirmationToken object

  • Creates a test mode Confirmation Token server side for your integration tests.

Country Spec

Templates related to Country Spec

  • Lists all Country Spec objects available in the API.

  • Returns a Country Spec for a given Country code.

Coupons

Templates related to Coupons

  • Returns a list of your coupons.

  • You can create coupons easily via the coupon management page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.

  • You can delete coupons via the coupon management page of the Stripe dashboard. However, deleting a coupon does not affect any customers who have already applied the coupon; it means that new customers can’t redeem the coupon. You can also delete coupons via the API.

  • Retrieves the coupon with the given ID.

  • Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.

Credit Notes

Templates related to Credit Notes

  • Issue a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces its amount_due.

  • Get a preview of a credit note without creating it.

  • When retrieving a credit note preview, you’ll get a lines property containing the first handful of those items. This URL you can retrieve the full (paginated) list of line items.

  • When retrieving a credit note, you’ll get a lines property containing the the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

  • Retrieves the credit note object with the given identifier.

  • Updates an existing credit note.

  • Marks a credit note as void. Learn more about voiding credit notes.

Customer Balance Transactions

Templates related to Customer Balance Transactions

  • Returns a list of transactions that updated the customer’s balances.

  • Creates an immutable transaction that updates the customer’s credit balance.

  • Retrieves a specific customer balance transaction that updated the customer’s balances.

  • Most credit balance transaction fields are immutable, but you may update its description and metadata.

Customer Cash Balance

Templates related to Customer Cash Balance

  • Retrieves a customer’s cash balance.

  • Changes the settings on a customer’s cash balance.

Customer Cash Balance Transactions

Templates related to Customer Cash Balance Transactions

  • Returns a list of transactions that modified the customer’s cash balance.

  • Retrieves a specific cash balance transaction, which updated the customer’s cash balance.

Customer Portal

Templates related to Customer Portal

  • Returns a list of configurations that describe the functionality of the customer portal.

  • Creates a configuration that describes the functionality and behavior of a PortalSession

  • Retrieves a configuration that describes the functionality of the customer portal.

  • Updates a configuration that describes the functionality of the customer portal.

  • Creates a session of the customer portal.

Customer Sessions

Templates related to Customer Sessions

  • Creates a customer session object that includes a single-use client secret that you can use on your front-end to grant client-side API access for certain customer resources.

Customers

Templates related to Customers

  • Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.

  • Creates a new customer object.

  • Search for customers you’ve previously created using Stripe’s Search Query Language.

  • Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.

  • Retrieves a Customer object.

  • Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the source parameter, that becomes the customer’s active source (e.g., a card) to be used for all charges in the future.

  • Retrieves a PaymentMethod object for a given Customer.

Discounts

Templates related to Discounts

  • Removes the currently applied discount on a customer.

Disputes

Templates related to Disputes

  • Returns a list of your disputes.

  • Retrieves the dispute with the given ID.

  • When you get a dispute, contacting your customer is always the best first step. If that doesn’t work, you can submit evidence to help us resolve the dispute in your favor.

  • Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.

Entitlement Features

Templates related to Entitlement Features

  • Retrieve a list of features

  • Creates a feature

  • Retrieves a feature

  • Update a feature’s metadata or permanently deactivate it.

Events

Templates related to Events

  • List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in event object api_version attribute (not according to your current Stripe API version or Stripe-Version header).

  • Retrieves the details of an event. Supply the unique identifier of the event, which you might have received in a webhook.

Exchange Rates

Templates related to Exchange Rates

  • Returns a list of objects that contain the rates at which foreign currencies are converted to one another. Only shows the currencies for which Stripe supports.

  • Retrieves the exchange rates from the given currency to every supported currency.

File Links

Templates related to File Links

  • Returns a list of file links.

  • Creates a new file link object.

  • Retrieves the file link with the given ID.

  • Updates an existing file link object. Expired links can no longer be updated.

Files

Templates related to Files

  • Returns a list of the files that your account has access to. Stripe sorts and returns the files by their creation dates, placing the most recently created files at the top.

  • To upload a file to Stripe, you need to send a request of type multipart/form-data. Include the file you want to upload in the request, and the parameters for creating a file.

  • Retrieves the details of an existing file object. After you supply a unique file ID, Stripe returns the corresponding file object. Learn how to access file contents.

Financial Connections Accounts

Templates related to Financial Connections Accounts

  • Returns a list of Financial Connections Account objects.

  • Retrieves the details of an Financial Connections Account.

  • Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).

  • Refreshes the data associated with a Financial Connections Account.

  • Subscribes to periodic refreshes of data associated with a Financial Connections Account.

  • Unsubscribes from periodic refreshes of data associated with a Financial Connections Account.

Financial Connections Sessions

Templates related to Financial Connections Sessions

  • To launch the Financial Connections authorization flow, create a Session. The session’s client_secret can be used to launch the flow using Stripe.js.

  • Retrieves the details of a Financial Connections Session

Financial Connections Transactions

Templates related to Financial Connections Transactions

  • Returns a list of Financial Connections Transaction objects.

  • Retrieves the details of a Financial Connections Transaction

Forwarding Requests

Templates related to Forwarding Requests

  • Lists all ForwardingRequest objects.

  • Creates a ForwardingRequest object.

  • Retrieves a ForwardingRequest object.

Identity

Templates related to Identity

  • List all verification reports.

  • Retrieves an existing VerificationReport

  • Returns a list of VerificationSessions

  • Creates a VerificationSession object.

  • Retrieves the details of a VerificationSession that was previously created.

  • Updates a VerificationSession object.

  • A VerificationSession object can be canceled when it is in requires_input status.

  • Redact a VerificationSession to remove all collected information from Stripe. This will redact the VerificationSession and all objects related to it, including VerificationReports, Events, request logs, etc.

Invoice Items

Templates related to Invoice Items

  • Returns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first.

  • Creates an item to be added to a draft invoice (up to 250 items per invoice). If no invoice is specified, the item will be on the next invoice created for the customer specified.

  • Deletes an invoice item, removing it from an invoice. Deleting invoice items is only possible when they’re not attached to invoices, or if it’s attached to a draft invoice.

  • Retrieves the invoice item with the given ID.

  • Updates the amount or description of an invoice item on an upcoming invoice. Updating an invoice item is only possible before the invoice it’s attached to is closed.

Invoices

Templates related to Invoices

  • You can list all invoices, or list the invoices for a specific customer. The invoices are returned sorted by creation date, with the most recently created invoices appearing first.

  • This endpoint creates a draft invoice for a given customer. The invoice remains a draft until you finalize the invoice, which allows you to pay or send the invoice to your customers.

  • Search for invoices you’ve previously created using Stripe’s Search Query Language.

  • At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc.

  • When retrieving an upcoming invoice, you’ll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

  • Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be voided.

  • Retrieves the invoice with the given ID.

  • Draft invoices are fully editable. Once an invoice is finalized, monetary values, as well as collection_method, become uneditable.

  • Stripe automatically finalizes drafts before sending and attempting payment on invoices. However, if you’d like to finalize a draft invoice manually, you can do so using this method.

  • When retrieving an invoice, you’ll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

  • Updates an invoice’s line item. Some fields, such as tax_amounts, only live on the invoice line item, so they can only be updated through this endpoint.

  • Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes.

  • Stripe automatically creates and then attempts to collect payment on invoices for customers on subscriptions according to your subscriptions settings. However, if you’d like to attempt payment on an invoice out of the normal collection schedule or for some other reason, you can do so.

  • Stripe will automatically send invoices to customers according to your subscriptions settings.

  • Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.

Issuing Authorizations

Templates related to Issuing Authorizations

  • Returns a list of Issuing Authorization objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

  • Retrieves an Issuing Authorization object.

  • Updates the specified Issuing Authorization object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

  • Create a test-mode authorization.

  • Capture a test-mode authorization.

  • Expire a test-mode Authorization.

  • Increment a test-mode Authorization.

  • Reverse a test-mode Authorization.

Issuing Cardholders

Templates related to Issuing Cardholders

  • Returns a list of Issuing Cardholder objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

  • Creates a new Issuing Cardholder object that can be issued cards.

  • Retrieves an Issuing Cardholder object.

  • Updates the specified Issuing Cardholder object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Issuing Cards

Templates related to Issuing Cards

  • Returns a list of Issuing Card objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

  • Creates an Issuing Card object.

  • Retrieves an Issuing Card object.

  • Updates the specified Issuing Card object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

  • Updates the shipping status of the specified Issuing Card object to failure.

  • Updates the shipping status of the specified Issuing Card object to returned.

  • Updates the shipping status of the specified Issuing Card object to shipped.

Issuing Disputes

Templates related to Issuing Disputes

  • Returns a list of Issuing Dispute objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

  • Creates an Issuing Dispute object. Individual pieces of evidence within the evidence object are optional at this point. Stripe only validates that required evidence is present during submission. Refer to Dispute reasons and evidence for more details about evidence requirements.

  • Retrieves an Issuing Dispute object.

  • Updates the specified Issuing Dispute object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Properties on the evidence object can be unset by passing in an empty string.

  • Submits an Issuing Dispute to the card network. Stripe validates that all evidence fields required for the dispute’s reason are present. For more details, see Dispute reasons and evidence.

Issuing Tokens

Templates related to Issuing Tokens

  • Lists all Issuing Token objects for a given card.

  • Retrieves an Issuing Token object.

  • Attempts to update the specified Issuing Token object to the status specified.

Issuing Transactions

Templates related to Issuing Transactions

  • Returns a list of Issuing Transaction objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

  • Retrieves an Issuing Transaction object.

  • Updates the specified Issuing Transaction object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

  • Allows the user to capture an arbitrary amount, also known as a forced capture.

  • Allows the user to refund an arbitrary amount, also known as a unlinked refund.

  • Refund a test-mode Transaction.

Mandates

Templates related to Mandates

  • Retrieves a Mandate object.

Payment Intents

Templates related to Payment Intents

  • Returns a list of PaymentIntents.

  • Creates a PaymentIntent object.

  • Search for PaymentIntents you’ve previously created using Stripe’s Search Query Language.

  • Retrieves the details of a PaymentIntent that has previously been created.

  • Updates properties on a PaymentIntent object without confirming.

  • Manually reconcile the remaining amount for a customer_balance PaymentIntent.

  • You can cancel a PaymentIntent object when it’s in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action or, in rare cases, processing.

  • Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.

  • Confirm that your customer intends to pay with current or provided payment method. Upon confirmation, the PaymentIntent will attempt to initiate a payment.

  • Perform an incremental authorization on an eligible PaymentIntent.

  • Verifies microdeposits on a PaymentIntent object.

Payment Links

Templates related to Payment Links

  • Returns a list of your payment links.

  • Creates a payment link.

  • Retrieve a payment link.

  • Updates a payment link.

  • When retrieving a payment link, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

Payment Method Configurations

Templates related to Payment Method Configurations

  • List payment method configurations

  • Creates a payment method configuration

  • Retrieve payment method configuration

  • Update payment method configuration

Payment Method Domains

Templates related to Payment Method Domains

  • Lists the details of existing payment method domains.

  • Creates a payment method domain.

  • Retrieves the details of an existing payment method domain.

  • Updates an existing payment method domain.

  • Some payment methods such as Apple Pay require additional steps to verify a domain. If the requirements weren’t satisfied when the domain was created, the payment method will be inactive on the domain.

Payment Methods

Templates related to Payment Methods

  • Returns a list of PaymentMethods for a given Customer

  • Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the List a Customer’s PaymentMethods API instead.

  • Creates a PaymentMethod object. Read the Stripe.js reference to learn how to create PaymentMethods via Stripe.js.

  • Retrieves a PaymentMethod object attached to the StripeAccount. To retrieve a payment method attached to a Customer, you should use Retrieve a Customer’s PaymentMethods

  • Updates a PaymentMethod object. A PaymentMethod must be attached a customer to be updated.

  • Attaches a PaymentMethod object to a Customer.

  • Detaches a PaymentMethod object from a Customer. After a PaymentMethod is detached, it can no longer be used for a payment or re-attached to a Customer.

Payouts

Templates related to Payouts

  • Returns a list of existing payouts sent to third-party bank accounts or payouts that Stripe sent to you. The payouts return in sorted order, with the most recently created payouts appearing first.

  • To send funds to your own bank account, create a new payout object.

  • Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list. Stripe returns the corresponding payout information.

  • Updates the specified payout by setting the values of the parameters you pass. We don’t change parameters that you don’t provide. This request only accepts the metadata as arguments.

  • You can cancel a previously created payout if its status is pending. Stripe refunds the funds to your available balance. You can’t cancel automatic Stripe payouts.

  • Reverses a payout by debiting the destination bank account.

Personalization Designs

Templates related to Personalization Designs

  • Returns a list of personalization design objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

  • Creates a personalization design object.

  • Retrieves a personalization design object.

  • Updates a card personalization object.

  • Updates the status of the specified testmode personalization design object to active.

  • Updates the status of the specified testmode personalization design object to inactive.

  • Updates the status of the specified testmode personalization design object to rejected.

Persons

Templates related to Persons

  • Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

  • Creates a new person.

  • Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.

  • Retrieves an existing person.

  • Updates an existing person.

Physical Bundles

Templates related to Physical Bundles

  • Retrieves a physical bundle object.

Prices

Templates related to Prices

  • Returns a list of your active prices, excluding inline prices. For the list of inactive prices, set active to false.

  • Creates a new price for an existing product. The price can be recurring or one-time.

  • Search for prices you’ve previously created using Stripe’s Search Query Language.

  • Retrieves the price with the given ID.

  • Updates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged.

Product Features

Templates related to Product Features

  • Retrieve a list of features for a product

  • Creates a product_feature, which represents a feature attachment to a product

  • Deletes the feature attachment to a product

  • Retrieves a product_feature, which represents a feature attachment to a product

Products

Templates related to Products

  • Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.

  • Creates a new product object.

  • Search for products you’ve previously created using Stripe’s Search Query Language.

  • Delete a product. Deleting a product is only possible if it has no prices associated with it. Additionally, deleting a product with type=good is only possible if it has no SKUs associated with it.

  • Retrieves the details of an existing product. Supply the unique product ID from either a product creation request or the product list, and Stripe will return the corresponding product information.

  • Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Promotion Codes

Templates related to Promotion Codes

  • Returns a list of your promotion codes.

  • A promotion code points to a coupon. You can optionally restrict the code to a specific customer, redemption limit, and expiration date.

  • Retrieves the promotion code with the given ID. In order to retrieve a promotion code by the customer-facing code use list with the desired code.

  • Updates the specified promotion code by setting the values of the parameters passed. Most fields are, by design, not editable.

Quote Line Items

Templates related to Quote Line Items

  • When retrieving a quote, there is an includable computed.upfront.line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of upfront line items.

  • When retrieving a quote, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

Quotes

Templates related to Quotes

  • Returns a list of your quotes.

  • A quote models prices and services for a customer. Default options for header, description, footer, and expires_at can be set in the dashboard via the quote template.

  • Retrieves the quote with the given ID.

  • A quote models prices and services for a customer.

  • Accepts the specified quote.

  • Cancels the quote.

  • Finalizes the quote.

  • Download the PDF for a finalized quote. Explanation for special handling can be found here

Radar Fraud Early Warnings

Templates related to Radar Fraud Early Warnings

  • Returns a list of early fraud warnings.

  • Retrieves the details of an early fraud warning that has previously been created.

Radar Reviews

Templates related to Radar Reviews

  • Returns a list of Review objects that have open set to true. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

  • Retrieves a Review object.

  • Approves a Review object, closing it and removing it from the list of reviews.

Radar Value List

Templates related to Radar Value List

  • Returns a list of ValueList objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

  • Creates a new ValueList object, which can then be referenced in rules.

  • Deletes a ValueList object, also deleting any items contained within the value list. To be deleted, a value list must not be referenced in any rules.

  • Retrieves a ValueList object.

  • Updates a ValueList object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Note that item_type is immutable.

Radar Value List Items

Templates related to Radar Value List Items

  • Returns a list of ValueListItem objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

  • Creates a new ValueListItem object, which is added to the specified parent value list.

  • Deletes a ValueListItem object, removing it from its parent value list.

  • Retrieves a ValueListItem object.

Refunds

Templates related to Refunds

  • Returns a list of all refunds you created. We return the refunds in sorted order, with the most recent refunds appearing first The 10 most recent refunds are always available by default on the Charge object.

  • When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.

  • Retrieves the details of an existing refund.

  • Updates the refund that you specify by setting the values of the passed parameters. Any parameters that you don’t provide remain unchanged.

Reporting Report Runs

Templates related to Reporting Report Runs

  • Returns a list of Report Runs, with the most recent appearing first.

  • Creates a new object and begin running the report. (Certain report types require a live-mode API key.)

  • Retrieves the details of an existing Report Run.

Reporting Report Type

Templates related to Reporting Report Type

  • Returns a full list of Report Types.

  • Retrieves the details of a Report Type. (Certain report types require a live-mode API key.)

Secret Management

Templates related to Secret Management

  • List all secrets stored on the given scope.

  • Create or replace a secret in the secret store.

  • Deletes a secret from the secret store by name and scope.

  • Finds a secret in the secret store by name and scope.

Setup Attempts

Templates related to Setup Attempts

  • Returns a list of SetupAttempts that associate with a provided SetupIntent.

Setup Intents

Templates related to Setup Intents

  • Returns a list of SetupIntents.

  • Creates a SetupIntent object.

  • Retrieves the details of a SetupIntent that has previously been created.

  • Updates a SetupIntent object.

  • You can cancel a SetupIntent object when it’s in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.

  • Confirm that your customer intends to set up the current or provided payment method. For example, you would confirm a SetupIntent when a customer hits the “Save” button on a payment method management page on your website.

  • Verifies microdeposits on a SetupIntent object.

Shipping Rates

Templates related to Shipping Rates

  • Returns a list of your shipping rates.

  • Creates a new shipping rate object.

  • Returns the shipping rate object with the given ID.

  • Updates an existing shipping rate object.

Sigma Scheduled Queries

Templates related to Sigma Scheduled Queries

  • Returns a list of scheduled query runs.

  • Retrieves the details of an scheduled query run.

Sources

Templates related to Sources

  • List sources for a specified customer.

  • When you create a new credit card, you must specify a customer or recipient on which to create it.

  • Delete a specified source for a given customer.

  • Retrieve a specified source for a given customer.

  • Update a specified source for a given customer.

  • Verify a specified bank account for a given customer.

  • Creates a new source object.

  • Retrieves an existing source object. Supply the unique source ID from a source creation request and Stripe will return the corresponding up-to-date source object information.

  • Updates the specified source by setting the values of the parameters passed.

Subscription Items

Templates related to Subscription Items

  • Returns a list of your subscription items for a given subscription.

  • Adds a new item to an existing subscription. No existing items will be changed or replaced.

  • Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.

  • Retrieves the subscription item with the given ID.

  • Updates the plan or quantity of an item on a current subscription.

  • For the specified subscription item, returns a list of summary objects. Each object in the list provides usage information that’s been summarized from multiple usage records and over a subscription billing period (e.g., 15 usage records in the month of September).

  • Creates a usage record for a specified subscription item and date, and fills it with a quantity.

Subscription Schedules

Templates related to Subscription Schedules

  • Retrieves the list of your subscription schedules.

  • Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.

  • Retrieves the details of an existing subscription schedule. You only need to supply the unique subscription schedule identifier that was returned upon subscription schedule creation.

  • Updates an existing subscription schedule.

  • Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is not_started or active.

  • Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is not_started or active. If the subscription schedule is currently associated with a subscription, releasing it will remove its subscription property and set the subscription’s ID to the released_subscription property.

Subscriptions

Templates related to Subscriptions

  • By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled.

  • Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.

  • Search for subscriptions you’ve previously created using Stripe’s Search Query Language.

  • Cancels a customer’s subscription immediately. The customer will not be charged again for the subscription.

  • Retrieves the subscription with the given ID.

  • Updates an existing subscription to match the specified parameters.

  • Removes the currently applied discount on a subscription.

Tax Calculations

Templates related to Tax Calculations

  • Calculates tax based on input and returns a Tax Calculation object.

  • Retrieves the line items of a persisted tax calculation as a collection.

  • Creates a Tax Transaction from a calculation.

Tax IDs

Templates related to Tax IDs

  • Returns a list of tax IDs for a customer.

  • Creates a new tax_id object for a customer.

  • Deletes an existing tax_id object.

  • Retrieves the tax_id object with the given identifier.

  • Returns a list of tax IDs.

  • Creates a new account or customer tax_id object.

  • Deletes an existing account or customer tax_id object.

  • Retrieves an account or customer tax_id object.

Tax Rates

Templates related to Tax Rates

  • Returns a list of your tax rates. Tax rates are returned sorted by creation date, with the most recently created tax rates appearing first.

  • Creates a new tax rate.

  • Retrieves a tax rate with the given ID

  • Updates an existing tax rate.

Tax Registrations

Templates related to Tax Registrations

  • Creates a new Tax Registration object.

  • Returns a Tax Registration object.

  • Updates an existing Tax Registration object.

Tax Settings

Templates related to Tax Settings

  • Retrieves Tax Settings for a merchant.

  • Updates Tax Settings parameters used in tax calculations. All parameters are editable but none can be removed once set.

Tax Transactions

Templates related to Tax Transactions

  • Partially or fully reverses a previously created Transaction.

  • Retrieves a Tax Transaction object.

  • Retrieves the line items of a committed standalone transaction as a collection.

Terminal Configurations

Templates related to Terminal Configurations

  • Returns a list of Configuration objects.

  • Creates a new Configuration object.

  • Deletes a Configuration object.

  • Retrieves a Configuration object.

  • Updates a new Configuration object.

Terminal Connection Tokens

Templates related to Terminal Connection Tokens

  • To connect to a reader the Stripe Terminal SDK needs to retrieve a short-lived connection token from Stripe, proxied through your server. On your backend, add an endpoint that creates and returns a connection token.

Terminal Locations

Templates related to Terminal Locations

  • Returns a list of Location objects.

  • Creates a new Location object.

  • Deletes a Location object.

  • Retrieves a Location object.

  • Updates a Location object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Terminal Readers

Templates related to Terminal Readers

  • Returns a list of Reader objects.

  • Creates a new Reader object.

  • Deletes a Reader object.

  • Retrieves a Reader object.

  • Updates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

  • Cancels the current reader action.

  • Initiates a payment flow on a Reader.

  • Initiates a setup intent flow on a Reader.

  • Initiates a refund on a Reader

  • Sets reader display to show cart details.

  • Presents a payment method on a simulated reader. Can be used to simulate accepting a payment, saving a card or refunding a transaction.

Test Clocks

Templates related to Test Clocks

  • Returns a list of your test clocks.

  • Creates a new test clock that can be attached to new customers and quotes.

  • Deletes a test clock.

  • Retrieves a test clock.

  • Starts advancing a test clock to a specified time in the future. Advancement is done when status changes to Ready.

Tokens

Templates related to Tokens

  • Creates a single-use token that represents a bank account’s details.

  • Retrieves the token with the given ID.

Top-ups

Templates related to Top-ups

  • Returns a list of top-ups.

  • Top up the balance of an account

  • Retrieves the details of a top-up that has previously been created. Supply the unique top-up ID that was returned from your previous request, and Stripe will return the corresponding top-up information.

  • Updates the metadata of a top-up. Other top-up details are not editable by design.

  • Cancels a top-up. Only pending top-ups can be canceled.

Transfer Reversals

Templates related to Transfer Reversals

  • You can see a list of the reversals belonging to a specific transfer. Note that the 10 most recent reversals are always available by default on the transfer object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional reversals.

  • When you create a new reversal, you must specify a transfer to create it on.

  • By default, you can see the 10 most recent reversals stored directly on the transfer object, but you can also retrieve details about a specific reversal stored on the transfer.

  • Updates the specified reversal by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Transfers

Templates related to Transfers

  • Returns a list of existing transfers sent to connected accounts. The transfers are returned in sorted order, with the most recently created transfers appearing first.

  • To send funds from your Stripe account to a connected account, you create a new transfer object. Your Stripe balance must be able to cover the transfer amount, or you’ll receive an “Insufficient Funds” error.

  • Retrieves the details of an existing transfer. Supply the unique transfer ID from either a transfer creation request or the transfer list, and Stripe will return the corresponding transfer information.

  • Updates the specified transfer by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Treasury CreditReversals

Templates related to Treasury CreditReversals

  • Returns a list of CreditReversals.

  • Reverses a ReceivedCredit and creates a CreditReversal object.

  • Retrieves the details of an existing CreditReversal by passing the unique CreditReversal ID from either the CreditReversal creation request or CreditReversal list

Treasury DebitReversals

Templates related to Treasury DebitReversals

  • Returns a list of DebitReversals.

  • Reverses a ReceivedDebit and creates a DebitReversal object.

  • Retrieves a DebitReversal object.

Treasury FinancialAccount Features

Templates related to Treasury FinancialAccount Features

  • Retrieves Features information associated with the FinancialAccount.

  • Updates the Features associated with a FinancialAccount.

Treasury FinancialAccounts

Templates related to Treasury FinancialAccounts

  • Returns a list of FinancialAccounts.

  • Creates a new FinancialAccount. For now, each connected account can only have one FinancialAccount.

  • Retrieves the details of a FinancialAccount.

  • Updates the details of a FinancialAccount.

Treasury InboundTransfers

Templates related to Treasury InboundTransfers

  • Transitions a test mode created InboundTransfer to the failed status. The InboundTransfer must already be in the processing state.

  • Transitions a test mode created InboundTransfer to the succeeded status. The InboundTransfer must already be in the processing state.

  • Returns a list of InboundTransfers sent from the specified FinancialAccount.

  • Creates an InboundTransfer.

  • Retrieves the details of an existing InboundTransfer.

  • Cancels an InboundTransfer.

Treasury OutboundPayments

Templates related to Treasury OutboundPayments

  • Transitions a test mode created OutboundPayment to the failed status. The OutboundPayment must already be in the processing state.

  • Transitions a test mode created OutboundPayment to the posted status. The OutboundPayment must already be in the processing state.

  • Transitions a test mode created OutboundPayment to the returned status. The OutboundPayment must already be in the processing state.

  • Returns a list of OutboundPayments sent from the specified FinancialAccount.

  • Creates an OutboundPayment.

  • Retrieves the details of an existing OutboundPayment by passing the unique OutboundPayment ID from either the OutboundPayment creation request or OutboundPayment list.

  • Cancel an OutboundPayment.

Treasury OutboundTransfers

Templates related to Treasury OutboundTransfers

  • Transitions a test mode created OutboundTransfer to the failed status. The OutboundTransfer must already be in the processing state.

  • Transitions a test mode created OutboundTransfer to the posted status. The OutboundTransfer must already be in the processing state.

  • Transitions a test mode created OutboundTransfer to the returned status. The OutboundTransfer must already be in the processing state.

  • Returns a list of OutboundTransfers sent from the specified FinancialAccount.

  • Creates an OutboundTransfer.

  • Retrieves the details of an existing OutboundTransfer by passing the unique OutboundTransfer ID from either the OutboundTransfer creation request or OutboundTransfer list.

  • An OutboundTransfer can be canceled if the funds have not yet been paid out.

Treasury ReceivedCredits

Templates related to Treasury ReceivedCredits

  • Use this endpoint to simulate a test mode ReceivedCredit initiated by a third party. In live mode, you can’t directly create ReceivedCredits initiated by third parties.

  • Returns a list of ReceivedCredits.

  • Retrieves the details of an existing ReceivedCredit by passing the unique ReceivedCredit ID from the ReceivedCredit list.

Treasury ReceivedDebits

Templates related to Treasury ReceivedDebits

  • Use this endpoint to simulate a test mode ReceivedDebit initiated by a third party. In live mode, you can’t directly create ReceivedDebits initiated by third parties.

  • Returns a list of ReceivedDebits.

  • Retrieves the details of an existing ReceivedDebit by passing the unique ReceivedDebit ID from the ReceivedDebit list

Treasury TransactionEntries

Templates related to Treasury TransactionEntries

  • Retrieves a list of TransactionEntry objects.

  • Retrieves a TransactionEntry object.

Treasury Transactions

Templates related to Treasury Transactions

  • Retrieves a list of Transaction objects.

  • Retrieves the details of an existing Transaction.

Webhook Endpoints

Templates related to Webhook Endpoints

  • Returns a list of your webhook endpoints.

  • A webhook endpoint must have a url and a list of enabled_events. You may optionally specify the Boolean connect parameter. If set to true, then a Connect webhook endpoint that notifies the specified url about events from all connected accounts is created; otherwise an account webhook endpoint that notifies the specified url only about events from your account is created. You can also create webhook endpoints in the webhooks settings section of the Dashboard.

  • You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.

  • Retrieves the webhook endpoint with the given ID.

  • Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.

Stripe Inbound Webhooks

Elements required for handling Webhooks sent by Stripe

  • Custom Metadata to store inbound webhooks signing key to verify Stripe calls. Used by the class below.

  • Custom Apex class that is used by the template below to verify that the inbound webhooks are coming from Stripe. It uses the Custom Metadata above.

  • Inbound Call Template for handling Stripe API Webhook calls. Uses the class above for verifying the sender.

In order to install this in your org, you need to access the library from the Declarative Webhooks app in your Salesforce org, Declarative Webhooks Library tab.