Skip to content
Create account or Sign in
The Stripe Docs logo
Search
Create accountSign in
OverviewAccept a payment
Online payments
OverviewFind your use caseRecurring paymentsMigrate legacy integrations
In-person payments
OverviewHow Terminal worksAvailability
Payment methods
Payment operations
Balances and settlement timeReceiptsRefunds and cancellations
Advanced integrations
Beyond payments

Create an embeddable buy button

Use Payment Links to create an embeddable buy button for your website.

Create an embeddable buy button to sell a product, subscription, or accept a payment on your website. Start by selecting an existing link from the Payment Links list view or by creating a new link where you can decide which products to sell and customize the checkout UI. After you create your link, click Buy button to configure the buy button design and generate the code that you can copy and paste into your website.

Customize the button

By default, your buy button uses the same branding and call to action configured for your payment link. You can:

  • Choose between a simple button and a card widget.
  • Set brand colors, shapes, and fonts to match your website.
  • Set the language of the button and payment page to match your website’s language.
  • Customize your button’s call to action.
Customize the buy button

Customize the buy button

Embed the button

Stripe provides an embed code composed of a <script> tag and a <stripe-buy-button> web component. Click Copy code to copy the code and paste it into your website.

If you’re using HTML, paste the embed code into the HTML. If you’re using React, include the script tag in your index.html page to mount the <stripe-buy-button> component.

Caution

The buy button uses your account’s publishable API key. If you revoke the API key, you need to update the embed code with your new publishable API key.

index.html
HTML
React
No results
<body>
  <h1>Purchase your new kit</h1>
  <!-- Paste your embed code script here. -->
  <script
    async
    src="https://js.stripe.com/v3/buy-button.js">
  </script>
  <stripe-buy-button
    buy-button-id=
"{{BUY_BUTTON_ID}}"

    publishable-key="pk_test_..."
  >
  </stripe-buy-button>
</body>

Attributes to customize checkout

ParameterDescriptionSyntax
client-reference-idUse client-reference-id to attach a unique string of your choice to the CheckoutSession. The string can be a customer ID, a cart ID, or something similar that you use to reconcile the CheckoutSession with your internal systems. If you pass this parameter to your <stripe-buy-button>, it’s sent in the checkout.session.completed webhook upon payment completion.The client-reference-id can contain alphanumeric characters, dashes, or underscores, and be any value up to 200 characters. Invalid values are silently dropped, but your payment page continues to work as expected.
customer-emailUse customer-email to prefill the email address on the payment page. When the property is set, the buy button passes it to the CheckoutSession’s customer_email attribute. The customer can’t edit the email address on the payment page.The customer-email must be a valid email. Invalid values are silently dropped, but your payment pages continues to work as expected.
customer-session-client-secretUse customer-session-client-secret to pass an existing customer.The customer-session-client-secret value must be generated from the client_secret.

Pass an existing customer

Use the Accounts v2 API to represent customers

The Accounts v2 API is generally available for Connect users, and in public preview for other Stripe users. If you’re part of the Accounts v2 preview, you need to specify a preview version in your code.

To join the Accounts v2 preview, go to Account previews and features in your Dashboard and enable Reusable payment methods for Global Payouts.

For most use cases, we recommend modeling your customers as customer-configured Account objects instead of using Customer objects.

You can provide an existing customer-configured Account object to CheckoutSessions created from the buy button. Authenticate the customer on the server, then create a CustomerSession for them and return the client_secret to the client.

Command Line
cURL
Stripe CLI
Ruby
Python
PHP
Java
Node.js
Go
.NET
No results
curl https://api.stripe.com/v1/customer_sessions \
  -u "sk_test_...:" \
  -d "customer_account=
{{CUSTOMER_ACCOUNT_ID}}
" \
  -d "components[buy_button][enabled]=true"

Set the customer-session-client-secret attribute on the <stripe-buy-button> web component to the client_secret from the CustomerSession.

You must provide the client_secret within 30 minutes. After providing the client secret, you have an additional 30 minutes until the CustomerSession expires. After it expires, the buy button can’t create any CheckoutSessions.

Don’t cache the client secret. Instead, generate a new one every time you render a buy button.

index.html
HTML
React
No results
<body>
  <script
    async
    src="https://js.stripe.com/v3/buy-button.js">
  </script>
  <stripe-buy-button
    buy-button-id=
"{{BUY_BUTTON_ID}}"

    publishable-key="pk_test_..."
    customer-session-client-secret="{{CLIENT_SECRET}}"
  >
  </stripe-buy-button>
</body>

Content Security Policy

If you’ve deployed a Content Security Policy, the policy directives that the buy button requires are:

  • frame-src, https://js.stripe.com
  • script-src, https://js.stripe.com

Limitations

Rendering the buy button requires a website domain. To test the buy button locally, run a local HTTP server to host your website’s index.html file over the localhost domain. To run a local HTTP server, use Python’s SimpleHTTPServer or the http-server npm module.

Track payments

After your customer makes a payment using a payment link, you can see it in the payments overview in the Dashboard.

If you’re new to Stripe, you receive an email after your first payment. To receive emails for all successful payments, update your notification preferences in your Personal details settings.

If you’re selling a subscription or saving a payment method for future use and don’t specify an existing customer, the Checkout Session creates a new customer. For one-time payments, the Checkout Session uses a guest customer instead.

Learn more about handling payment links post-payment, like how to configure post-payment behavior for a buy button or payment link.

On this page