Create a payment link with the API

Payment Links uses Products and Prices to model what your business is selling.

To get started with Payment Links, you first need to create a product, and then use that product to create a price.

Read our guide on managing products and prices for more information.

Payment Links only supports Standard pricing (charging the same price for each unit—either one time or recurring) and Customer chooses price (letting your customer specify the price). It doesn’t support advanced options like package pricing, graduated pricing, or volume pricing.

curl https://api.stripe.com/v1/prices \
  -u "
sk_test_4eC39HqLyjWDarjtT1zdp7dc
:" \
  -d currency=usd \
  -d unit_amount=1000 \
  -d product=
{{PRODUCT_ID}}

To create a payment link, pass in line_items.

Each line item contains a price and quantity.

curl https://api.stripe.com/v1/payment_links \
  -u "
sk_test_4eC39HqLyjWDarjtT1zdp7dc
:" \
  -d "line_items[0][price]"=
{{PRICE_ID}} \
  -d "line_items[0][quantity]"=1

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.

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 the guide for 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.

curl https://api.stripe.com/v1/payment_links \
  -u "
sk_test_4eC39HqLyjWDarjtT1zdp7dc
:" \
  -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"

After creating a payment link, you can’t delete it. Instead, you can deactivate a payment link by setting the active parameter to false.

After you deactivate a payment link, customers can no longer complete purchases using the link and are redirected to an expiration page instead.

To reuse a deactivated payment link, reactivate it by setting the active parameter to true.