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 Sessions API

The Sessions API from Stripe — 14 operation(s) for sessions.

Stripe Sessions API is one of 159 APIs that Stripe publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Sessions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 17 operations across 14 paths, and defines 28 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/.

17 operations 14 paths 28 schemas 7 GET10 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 Sessions 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 17

Across 14 paths, the API surfaces 17 operations — 7 GET, 10 POST. Each is listed below with its method, path, parameters, and response codes.

Sessions 17
POST
/v1/account_sessions
Stripe Create Account Session
PostAccountSessions body → 200default
POST
/v1/billing_portal/sessions
Stripe Post Billing Portal Sessions
postBillingPortalSessions body → 200default
GET
/v1/checkout/sessions
Stripe Get Checkout Sessions
getCheckoutSessions 11 params body → 200default
POST
/v1/checkout/sessions
Stripe Post Checkout Sessions
postCheckoutSessions body → 200default
GET
/v1/checkout/sessions/{session}
Stripe Get Checkout Sessions Session
getCheckoutSessionsSession 2 params body → 200default
POST
/v1/checkout/sessions/{session}/expire
Stripe Post Checkout Sessions Session Expire
postCheckoutSessionsSessionExpire 1 param body → 200default
GET
/v1/checkout/sessions/{session}/line_items
Stripe Get Checkout Sessions Session Line Items
getCheckoutSessionsSessionLineItems 5 params body → 200default
POST
/v1/financial_connections/sessions
Stripe Post Financial Connections Sessions
postFinancialConnectionsSessions body → 200default
GET
/v1/financial_connections/sessions/{session}
Stripe Get Financial Connections Sessions Session
getFinancialConnectionsSessionsSession 2 params body → 200default
GET
/v1/identity/verification_sessions
Stripe Get Identity Verification Sessions
getIdentityVerificationSessions 6 params body → 200default
POST
/v1/identity/verification_sessions
Stripe Post Identity Verification Sessions
postIdentityVerificationSessions body → 200default
GET
/v1/identity/verification_sessions/{session}
Stripe Get Identity Verification Sessions Session
getIdentityVerificationSessionsSession 2 params body → 200default
POST
/v1/identity/verification_sessions/{session}
Stripe Post Identity Verification Sessions Session
postIdentityVerificationSessionsSession 1 param body → 200default
POST
/v1/identity/verification_sessions/{session}/cancel
Stripe Post Identity Verification Sessions Session Cancel
postIdentityVerificationSessionsSessionCancel 1 param body → 200default
POST
/v1/identity/verification_sessions/{session}/redact
Stripe Post Identity Verification Sessions Session Redact
postIdentityVerificationSessionsSessionRedact 1 param body → 200default
POST
/v1/link_account_sessions
Stripe Post Link Account Sessions
postLinkAccountSessions body → 200default
GET
/v1/link_account_sessions/{session}
Stripe Get Link Account Sessions Session
getLinkAccountSessionsSession 2 params body → 200default

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are checkout.session (54 properties), PostCheckoutSessionsRequest (38 properties), financial_connections.account (19 properties), identity.verification_session (14 properties). Each schema is shown below with its type and property counts.

billing_portal.session
object
The Billing customer portal is a Stripe-hosted UI for subscription and billing management. A portal configuration describes the functionality and features that…
11 properties 7 required
GetIdentityVerificationSessionsSessionRequest
object
GelatoVerificationSessionList
object
4 properties 4 required
PostCheckoutSessionsSessionExpireRequest
object
1 property
checkout.session
object
A Checkout Session represents your customer's session as they pay for one-time purchases or subscriptions through [Checkout](https://stripe.com/docs/payments/c…
54 properties 12 required
financial_connections.account
object
A Financial Connections Account represents an account that exists outside of Stripe, to which you have been granted some degree of access.
19 properties 9 required
identity.verification_session
object
A VerificationSession guides you through the process of collecting and verifying the identities of your users. It contains details about the type of verificati…
14 properties 6 required
financial_connections.session
object
A Financial Connections Session is the secure way to programmatically launch the client-side Stripe.js modal that lets your users link their accounts.
10 properties 6 required
PaymentPagesCheckoutSessionListLineItems
object
4 properties 4 required
GetCheckoutSessionsSessionRequest
object
PostFinancialConnectionsSessionsRequest
object
6 properties 2 required
PostCheckoutSessionsRequest
object
38 properties
error
object
An error response from the Stripe API
1 property 1 required
GetLinkAccountSessionsSessionRequest
object
identity.verification_report
object
A VerificationReport is the result of an attempt to collect and verify data from a user. The collection of verification checks performed is determined from the…
10 properties 4 required
GetFinancialConnectionsSessionsSessionRequest
object
PostIdentityVerificationSessionsSessionRedactRequest
object
1 property
GetCheckoutSessionsSessionLineItemsRequest
object
PostIdentityVerificationSessionsSessionCancelRequest
object
1 property
billing_portal.configuration
object
A portal configuration describes the functionality and behavior of a portal session.
13 properties 10 required
PostBillingPortalSessionsRequest
object
7 properties 1 required
PostLinkAccountSessionsRequest
object
6 properties 2 required
PostIdentityVerificationSessionsSessionRequest
object
4 properties
PaymentPagesCheckoutSessionList
object
4 properties 4 required
GetIdentityVerificationSessionsRequest
object
GetCheckoutSessionsRequest
object
account_session
object
An AccountSession allows a Connect platform to grant access to a connected account in Connect embedded components. We recommend that you create an AccountSessi…
6 properties 6 required
PostIdentityVerificationSessionsRequest
object
5 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

stripe-sessions-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 Sessions 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.