Skip to content
Create account
 or
Sign in
The Stripe Docs logo
/
Create account
Sign in
OverviewUpgrade your integration
Online payments
OverviewFind your use caseManaged Payments
Payment methods
Payment interfaces
Payment scenarios
In-person payments
Beyond payments

Use the API to create and manage payment links

Create and manage payment links with the 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.

Set up your product catalog

Payment Links use Products and Prices to model what your business is selling. To get started with Payment Links, create a product, then use that product to create a price. Alternatively, if you want to create an ad-hoc price or product for one-time use, you can skip this step and use price_data in step 2.

Payment Links supports flat rate, tiered, package and Customer chooses (letting your customer specify the price) prices. Customer choose prices currently doesn’t support recurring payments or donations.

Use Flat rate to create a product or subscription with a fixed amount.

Command Line
cURL
Stripe CLI
Ruby
Python
PHP
Java
Node
Go
.NET
No results
curl https://api.stripe.com/v1/prices \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d currency=usd \
  -d unit_amount=1000 \
  -d product=
{{PRODUCT_ID}}

Create a payment link

To create a payment link, pass in line_items. Each line item contains a price (or price_data) and quantity. Payment links can contain up to 20 line items when using a flat rate and 1 line item when using Customer chooses price.

Command Line
cURL
Stripe CLI
Ruby
Python
PHP
Java
Node
Go
.NET
No results
curl https://api.stripe.com/v1/payment_links \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d "line_items[0][price]"=
{{PRICE_ID}}
 \
  -d "line_items[0][quantity]"=1

Share your payment link

Each payment link contains a url that you can share with your customers through email, on social media, with a website link, in an app, or through other channels.

Track payments

When customers use a payment link to complete a payment, Stripe sends a checkout.session.completed webhook that you can use for fulfillment and reconciliation.

Make sure to listen to additional webhooks in case you’ve enabled payment methods like bank debits or vouchers, which can take 2-14 days to confirm the payment. For more information, see our guide on fulfilling orders after a customer pays.

After a customer completes a purchase, you can redirect them to a URL or display a custom message by setting after_completion on the payment link.

Command Line
cURL
Stripe CLI
Ruby
Python
PHP
Java
Node
Go
.NET
No results
curl https://api.stripe.com/v1/payment_links \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d "line_items[0][price]"=
{{PRICE_ID}}
 \
  -d "line_items[0][quantity]"=1 \
  -d "after_completion[type]"=redirect \
  --data-urlencode "after_completion[redirect][url]"="https://example.com"

Deactivate a payment link

After you’ve created a payment link, you can’t delete it. What you can do is deactivate a payment link by setting the active attribute to false.

After you deactivate a link, customers can’t finalize purchases using the link anymore and are redirected to an expiration page. If you want to reuse a deactivated payment link, turn it back on by setting the active attribute to true.

Configure payment methods

By default, Stripe selects the relevant payment methods that you enabled in your Dashboard. To add supported payment methods, enable them in your Payment methods settings.

Was this page helpful?
YesNo