Stripe (APIs.json)

Millions of companies of all sizes use Stripe online and in person to accept payments, send payouts, automate financial processes, and ultimately grow revenue.

Stripe Accounts API

This is an object representing a Stripe account. You can retrieve it to see properties on the account like its current requirements or if the account is enabled to make live charges or receive payouts.

Properties

Stripe Apple Pay API

Stripe users can accept Apple Pay in iOS applications in iOS 9 and above, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the pricing is the same as other card transactions.

Properties

Stripe Application Fees API

When you collect a transaction fee on top of a charge made for your user (using Connect), an Application Fee object is created in your account. You can list, retrieve, and refund application fees.

Properties

Stripe Application Secrets API

Secret Store is an API that allows Stripe Apps developers to securely persist secrets for use by UI Extensions and app backends.

Properties

Stripe Balance API

This is an object representing your Stripe balance. You can retrieve it to see the balance currently on your Stripe account. You can also retrieve the balance history, which contains a list of transactions that contributed to the balance (charges, payouts, and so forth).

Properties

Stripe Billing API

Create and manage subscriptions, recurring payments, and recurring revenue.

Properties

Stripe Charges API

The Charge object represents a single attempt to move money into your Stripe account. PaymentIntent confirmation is the most common way to create Charges, but transferring money to a different Stripe account through Connect also creates Charges. Some legacy payment flows create Charges directly, which is not recommended for new integrations.

Properties

Stripe Checkout API

Checkout is a low-code payment integration that creates a customizable form for collecting payments. You can embed Checkout directly in your website or redirect customers to a Stripe-hosted payment page. It supports one-time payments and subscriptions and accepts over 40 local payment methods.

Properties

Stripe Climate API

Stripe Climate is the easiest way to help promising permanent carbon removal technologies launch and scale. Join a growing group of ambitious businesses that are changing the course of carbon removal.

Properties

Stripe Country API

Stripe needs to collect certain pieces of information about each account created. These requirements can differ depending on the account’s country. The Country Specs API makes these rules available to your integration.

Properties

Stripe Coupons API

A coupon contains information about a percent-off or amount-off discount you might want to apply to a customer. Coupons may be applied to subscriptions, invoices, checkout sessions, quotes, and more. Coupons do not work with conventional one-off charges or payment intents.

Properties

Stripe Credit Notes API

Issue a credit note to adjust an invoice’s amount after the invoice is finalized.

Properties

Stripe Customers API

This object represents a customer of your business. Use it to create recurring charges and track payments that belong to the same customer.

Properties

Stripe Disputes API

A dispute occurs when a customer questions your charge with their card issuer. When this happens, you have the opportunity to respond to the dispute with evidence that shows that the charge is legitimate.

Properties

Stripe Ephemeral Keys API

Stripe.js uses ephemeral keys to securely retrieve Card information from the Stripe API without publicly exposing your secret keys. You need to do some of the ephemeral key exchange on the server-side to set this up.

Properties

Stripe Events API

Events are our way of letting you know when something interesting happens in your account. When an interesting event occurs, we create a new Event object.

Properties

Stripe Exchange Rates API

Stripe supports processing charges in 135+ currencies allowing you to present prices in a customer’s native currency. Doing so can improve sales and help customers avoid conversion costs. In order to present prices in your customer’s currency, you need to specify the presentment currency when creating a PaymentIntent or a charge.

Properties

Stripe Files API

This object represents files hosted on Stripe’s servers. You can upload files with the create file request (for example, when uploading dispute evidence). Stripe also creates files independently (for example, the results of a Sigma scheduled query).

Properties

Stripe Financial Connections API

Financial Connections lets your users securely share their financial data by linking their financial accounts to your business. Use Financial Connections to access user-permissioned account data such as tokenized account and routing numbers, balances, ownerships details, and transactions.

Properties

Stripe Identity API

Use Stripe Identity to confirm the identity of global users to prevent fraud, streamline risk operations, and increase trust and safety.

Properties

Stripe Invoice API

Invoices are statements of amounts owed by a customer, and are either generated one-off, or generated periodically from a subscription.

Properties

Stripe Issuing API

An API for businesses to instantly create, manage, and distribute payment cards.

Properties

Stripe Link API

You can use the Payment Links API to create a payment link that you can share with your customers. Stripe redirects customers who open this link to a Stripe-hosted payment page.

Properties

Stripe Payment Intents API

A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session.

Properties

Stripe Payment Links API

A payment link is a shareable URL that will take your customers to a hosted payment page. A payment link can be shared and used multiple times. When a customer opens a payment link it will open a new checkout session to render the payment page. You can use checkout session events to track payments through payment links.

Properties

Stripe Payment Method API

The Payment Methods API allows you to accept a variety of payment methods through a single API. A PaymentMethod object contains the payment method details to create payments.

Properties

Stripe Payouts API

A Payout object is created when you receive funds from Stripe, or when you initiate a payout to either a bank account or debit card of a connected Stripe account. You can retrieve individual payouts, and list all payouts. Payouts are made on varying schedules, depending on your country and industry.

Properties

Stripe Plans API

You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.

Properties

Stripe Prices API

Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products. Products help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme.

Properties

Stripe Products API

Products describe the specific goods or services you offer to your customers. For example, you might offer a Standard and Premium version of your goods or service; each version would be a separate Product. They can be used in conjunction with Prices to configure pricing in Payment Links, Checkout, and Subscriptions.

Properties

Stripe Promotion Codes API

A Promotion Code represents a customer-redeemable code for a coupon. It can be used to create multiple codes for a single coupon.

Properties

Stripe Quotes API

A Quote is a way to model prices that you’d like to provide to a customer. Once accepted, it will automatically create an invoice, subscription or subscription schedule.

Properties

Stripe Radar API

Stripe Radar provides real-time fraud protection and requires no additional development time. Fraud professionals can add Radar for Fraud Teams to customize protection and get deeper insights.

Properties

Stripe Refunds API

Refund objects allow you to refund a previously created charge that isn’t refunded yet. Funds are refunded to the credit or debit card that’s initially charged.

Properties

Stripe Reporting API

The financial reports in the Dashboard provide downloadable reports in CSV format for a variety of accounting and reconciliation tasks. These reports are also available through the API, so you can schedule them to run automatically or run them whenever you need to receive the associated report files for accounting purposes.

Properties

Stripe Reviews API

Reviews can be used to supplement automated fraud detection with human expertise.

Properties

Stripe Setup API

Use the Setup Intents API to set up a payment method for future payments. It’s similar to a payment, but no charge is created. Set up a payment method for future payments now.

Properties

Stripe Shipping Rates API

Shipping rates describe the price of shipping presented to your customers and applied to a purchase.

Properties

Stripe Sigma API

If you have scheduled a Sigma query, you’ll receive a sigma.scheduled_query_run.created webhook each time the query runs. The webhook contains a ScheduledQueryRun object, which you can use to retrieve the query results.

Properties

Stripe Sources API

Source objects allow you to accept a variety of payment methods. They represent a customer’s payment instrument, and can be used with the Stripe API just like a Card object once chargeable, they can be charged, or can be attached to customers.

Properties

Stripe Subscription API

Subscriptions allow you to charge a customer on a recurring basis.

Properties

Stripe Tax API

Automate sales tax, VAT, and GST compliance on all your transactions—low or no code integrations available.

Properties

Stripe Terminal API

Use Stripe Terminal to accept in-person payments and extend Stripe payments to your point of sale.

Properties

Stripe Test Helpers API

Stripe provides a number of resources for testing your integration. Make sure to test the following use cases before launch, and use our Postman collection to make the testing process simpler.

Properties

Stripe Tokens API

Tokenization is the process Stripe uses to collect sensitive card or bank account details, or personally identifiable information (PII), directly from your customers in a secure manner. A token representing this information is returned to your server to use. Use our recommended payments integrations to perform this process on the client-side. This guarantees that no sensitive card data touches your server, and allows your integration to operate in a PCI-compliant way.

Properties

Stripe Topups API

To top up your Stripe balance, you create a top-up object. You can retrieve individual top-ups, as well as list all top-ups. Top-ups are identified by a unique, random ID.

Properties

Stripe Transfers API

A Transfer object is created when you move funds between Stripe accounts as part of Connect.

Properties

Stripe Treasury API

Stripe Treasury is a banking-as-a-service API that lets you embed financial services in your product. With Stripe’s API, you can enable businesses to hold funds, pay bills, earn yield, and manage their cash flow. Many users build Stripe Issuing in conjunction with Stripe Treasury to attach cards to spend funds in the account.

Properties

Stripe Webhook API

You can configure webhook endpoints via the API to be notified about events that happen in your Stripe account or connected accounts.

Stripe (APIs.json)

Stripe Accounts API

Properties

Tags

Stripe Apple Pay API

Properties

Tags

Stripe Application Fees API

Properties

Tags

Stripe Application Secrets API

Properties

Tags

Stripe Balance API

Properties

Tags

Stripe Billing API

Properties

Tags

Stripe Charges API

Properties

Tags

Stripe Checkout API

Properties

Tags

Stripe Climate API

Properties

Tags

Stripe Country API

Properties

Tags

Stripe Coupons API

Properties

Tags

Stripe Credit Notes API

Properties

Tags

Stripe Customers API

Properties

Tags

Stripe Disputes API

Properties

Tags

Stripe Ephemeral Keys API

Properties

Tags

Stripe Events API

Properties

Tags

Stripe Exchange Rates API

Properties

Tags

Stripe Files API

Properties

Tags

Stripe Financial Connections API

Properties

Tags

Stripe Identity API

Properties

Tags

Stripe Invoice API

Properties

Tags

Stripe Issuing API

Properties

Tags

Stripe Link API

Properties

Tags

Stripe Payment Intents API

Properties

Tags

Stripe Payment Links API

Properties

Tags

Stripe Payment Method API

Properties

Tags

Stripe Payouts API