Core Resources
Payment Methods
Products
Product Catalog
Commerce
Agentic Commerce
Checkout
Payment Links
Billing
Capital
Connect
Reserves
Fraud
Issuing
Terminal
Treasury for Platforms
Payment Records
Account Evaluation
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Privacy
Webhooks

Payment Links v1

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.

Related guide: Payment Links API

Was this section helpful?YesNo
Create a payment link
POST/v1/payment_links
Update a payment link
POST/v1/payment_links/:id
Retrieve payment link
GET/v1/payment_links/:id
Retrieve a payment link's line items
GET/v1/payment_links/:id/line_items
List all payment links
GET/v1/payment_links

The Payment Link object v1

Attributes

  • idstring

    Unique identifier for the object.

  • activeboolean

    Whether the payment link’s url is active. If false, customers visiting the URL will be shown a page saying that the link has been deactivated.

  • line_itemsobjectIncludable

    The line items representing what is being sold.

  • metadatamap

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

  • urlstring

    The public URL that can be shared with customers.

More attributes

  • objectstring, value is "payment_link"

  • after_completionobject

  • allow_promotion_codesboolean

  • applicationnullable stringExpandableConnect only

  • application_fee_amountnullable integerConnect only

  • application_fee_percentnullable numberConnect only

  • automatic_taxobject

  • billing_address_collectionenum

  • consent_collectionnullable object

  • currencyenum

  • custom_fieldsarray of objects

  • custom_textobject

  • customer_creationenum

  • inactive_messagenullable string

  • invoice_creationnullable object

  • livemodeboolean

  • managed_paymentsnullable object

  • name_collectionnullable object

  • on_behalf_ofnullable stringExpandableConnect only

  • optional_itemsnullable array of objectsIncludable

  • payment_intent_datanullable object

  • payment_method_collectionenum

  • payment_method_optionsnullable object

  • payment_method_typesnullable array of enums

  • phone_number_collectionobject

  • restrictionsnullable object

  • shipping_address_collectionnullable object

  • shipping_optionsarray of objects

  • submit_typeenum

  • subscription_datanullable object

  • tax_id_collectionobject

  • transfer_datanullable objectConnect only

The Payment Link object
{
  "id": "",
  "object": "payment_link",
  "active": true,
  "after_completion": {
    "hosted_confirmation": {
      "custom_message": null
    },
    "type": "hosted_confirmation"
  },
  "allow_promotion_codes": false,
  "application_fee_amount": null,
  "application_fee_percent": null,
  "automatic_tax": {
    "enabled": false,
    "liability": null
  },
  "billing_address_collection": "auto",
  "consent_collection": null,
  "currency": "usd",
  "custom_fields": [],
  "custom_text": {
    "shipping_address": null,
    "submit": null
  },
  "customer_creation": "if_required",
  "invoice_creation": {
    "enabled": false,
    "invoice_data": {
      "account_tax_ids": null,
      "custom_fields": null,
      "description": null,
      "footer": null,
      "issuer": null,
      "metadata": {},
      "rendering_options": null
    }
  },
  "livemode": false,
  "metadata": {},
  "on_behalf_of": null,
  "payment_intent_data": null,
  "payment_method_collection": "always",
  "payment_method_types": null,
  "phone_number_collection": {
    "enabled": false
  },
  "shipping_address_collection": null,
  "shipping_options": [],
  "submit_type": "auto",
  "subscription_data": {
    "description": null,
    "invoice_settings": {
      "issuer": {
        "type": "self"
      }
    },
    "trial_period_days": null
  },
  "tax_id_collection": {
    "enabled": false
  },
  "transfer_data": null,
  "url": "https://buy.stripe.com/test_cN25nr0iZ7bUa7meUY"
}

Create a payment link v1

POST /v1/payment_links

Creates a payment link.

Parameters

  • line_itemsarray of objectsRequired

    The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported.

  • metadatamap

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata. Metadata associated with this Payment Link will automatically be copied to checkout sessions created by this payment link.

More parameters

  • after_completionobject

  • allow_promotion_codesboolean

  • application_fee_amountintegerConnect only

  • application_fee_percentnumberConnect only

  • automatic_taxobject

  • billing_address_collectionenum

  • consent_collectionobject

  • currencyenum

  • custom_fieldsarray of objects

  • custom_textobject

  • customer_creationenum

  • inactive_messagestring

  • invoice_creationobject

  • managed_paymentsobject

  • name_collectionobject

  • on_behalf_ofstringConnect only

  • optional_itemsarray of objects

  • payment_intent_dataobject

  • payment_method_collectionenum

  • payment_method_optionsobject

  • payment_method_typesarray of enums

  • phone_number_collectionobject

  • restrictionsobject

  • shipping_address_collectionobject

  • shipping_optionsarray of objects

  • submit_typeenum

  • subscription_dataobject

  • tax_id_collectionobject

  • transfer_dataobjectConnect only

Returns

Returns the payment link.

curl https://api.stripe.com/v1/payment_links \
  -u "sk_test_BQokikJOvBiI2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d "line_items[0][price]=" \
  -d "line_items[0][quantity]=1"
Response
{
  "id": "",
  "object": "payment_link",
  "active": true,
  "after_completion": {
    "hosted_confirmation": {
      "custom_message": null
    },
    "type": "hosted_confirmation"
  },
  "allow_promotion_codes": false,
  "application_fee_amount": null,
  "application_fee_percent": null,
  "automatic_tax": {
    "enabled": false,
    "liability": null
  },
  "billing_address_collection": "auto",
  "consent_collection": null,
  "currency": "usd",
  "custom_fields": [],
  "custom_text": {
    "shipping_address": null,
    "submit": null
  },
  "customer_creation": "if_required",
  "invoice_creation": {
    "enabled": false,
    "invoice_data": {
      "account_tax_ids": null,
      "custom_fields": null,
      "description": null,
      "footer": null,
      "issuer": null,
      "metadata": {},
      "rendering_options": null
    }
  },
  "livemode": false,
  "metadata": {},
  "on_behalf_of": null,
  "payment_intent_data": null,
  "payment_method_collection": "always",
  "payment_method_types": null,
  "phone_number_collection": {
    "enabled": false
  },
  "shipping_address_collection": null,
  "shipping_options": [],
  "submit_type": "auto",
  "subscription_data": {
    "description": null,
    "invoice_settings": {
      "issuer": {
        "type": "self"
      }
    },
    "trial_period_days": null
  },
  "tax_id_collection": {
    "enabled": false
  },
  "transfer_data": null,
  "url": "https://buy.stripe.com/test_cN25nr0iZ7bUa7meUY"
}