How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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.

Stripe Payment Links API is one of 159 APIs that Stripe publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Link, Links, and Payments. The published artifact set on APIs.io includes API documentation and an OpenAPI specification.

This API exposes 5 operations across 3 paths, and defines 9 schemas. It is described by OpenAPI 3.2.0, at version 2023-10-16.

Requests are made against a single base URL, https://api.stripe.com/.

5 operations 3 paths 9 schemas 3 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2023-10-16
Server
https://api.stripe.com/
Authentication
HTTP Basic, HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 2

Stripe Payment Links API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It accepts HTTP bearer tokens (auth-scheme) (bearerAuth). By default, every request must be authenticated.

  • basicAuth — Basic HTTP authentication. Allowed headers-- Authorization: Basic | Authorization: Basic
  • bearerAuth — Bearer HTTP authentication. Allowed headers-- Authorization: Bearer

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Payment Links 5
GET
/v1/payment_links
Returns a list of your payment links.
GetPaymentLinks 5 params body → 200default
POST
/v1/payment_links
Creates a payment link.
PostPaymentLinks body → 200default
GET
/v1/payment_links/{payment_link}
Retrieve a payment link.
GetPaymentLinksPaymentLink 2 params body → 200default
POST
/v1/payment_links/{payment_link}
Updates a payment link.
PostPaymentLinksPaymentLink 1 param body → 200default
GET
/v1/payment_links/{payment_link}/line_items
When retrieving a payment link, there is an includable lineitems property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line ite…
GetPaymentLinksPaymentLinkLineItems 5 params body → 200default

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are payment_link (33 properties), PostPaymentLinksRequest (28 properties), PostPaymentLinksPaymentLinkRequest (19 properties), PaymentLinksResourceListLineItems (4 properties). Each schema is shown below with its type and property counts.

PaymentLinksResourcePaymentLinkList
object
4 properties 4 required
GetPaymentLinksRequest
object
PostPaymentLinksPaymentLinkRequest
object
19 properties
payment_link
object
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…
33 properties 19 required
PostPaymentLinksRequest
object
28 properties 1 required
error
object
An error response from the Stripe API
1 property 1 required
GetPaymentLinksPaymentLinkRequest
object
GetPaymentLinksPaymentLinkLineItemsRequest
object
PaymentLinksResourceListLineItems
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

stripe-payment-links-api-openapi.yml Raw ↑

Other APIs Stripe publishes across the network.

Stripe Accounts API
Stripe Balance API
Stripe Billing API
Stripe Charges API
Stripe Checkout API
Stripe Climate API
Stripe Country API
Stripe Coupons API
Stripe Credit Notes API
Stripe Customers API
Stripe Disputes API
Stripe Ephemeral Keys API
Where this information came from

This is an independent, third-party profile of Stripe Payment Links API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.