{ "opencollection": "1.0.0", "info": { "name": "Stripe Accounts Account Sessions API", "version": "2023-10-16" }, "items": [ { "info": { "name": "Sessions", "type": "folder" }, "items": [ { "info": { "name": "Stripe Create Account Session", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/account_sessions", "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Creates a AccountSession object that includes a single-use token that the platform can use on their front-end to grant client-side API access.

" }, { "info": { "name": "Stripe Post Billing Portal Sessions", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/billing_portal/sessions", "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Creates a session of the customer portal.

" }, { "info": { "name": "Stripe Get Checkout Sessions", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/checkout/sessions", "params": [ { "name": "created", "value": "", "type": "query", "description": "Only return the Checkout Sessions that were created during the given date interval." }, { "name": "customer", "value": "", "type": "query", "description": "Only return the Checkout Sessions for the Customer specified." }, { "name": "customer_details", "value": "", "type": "query", "description": "Only return the Checkout Sessions for the Customer details specified." }, { "name": "ending_before", "value": "", "type": "query", "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "payment_intent", "value": "", "type": "query", "description": "Only return the Checkout Session for the PaymentIntent specified." }, { "name": "payment_link", "value": "", "type": "query", "description": "Only return the Checkout Sessions for the Payment Link specified." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list." }, { "name": "status", "value": "", "type": "query", "description": "Only return the Checkout Sessions matching the given status." }, { "name": "subscription", "value": "", "type": "query", "description": "Only return the Checkout Session for the subscription specified." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Returns a list of Checkout Sessions.

" }, { "info": { "name": "Stripe Post Checkout Sessions", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/checkout/sessions", "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Creates a Session object.

" }, { "info": { "name": "Stripe Get Checkout Sessions Session", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/checkout/sessions/:session", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "session", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Retrieves a Session object.

" }, { "info": { "name": "Stripe Post Checkout Sessions Session Expire", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/checkout/sessions/:session/expire", "params": [ { "name": "session", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

A Session can be expired when it is in one of these statuses: open

\n\n

After it expires, a customer can’t complete a Session and customers loading the Session see a message saying the Session is expired.

" }, { "info": { "name": "Stripe Get Checkout Sessions Session Line Items", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/checkout/sessions/:session/line_items", "params": [ { "name": "ending_before", "value": "", "type": "query", "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "session", "value": "", "type": "path" }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

When retrieving a Checkout Session, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

" }, { "info": { "name": "Stripe Post Financial Connections Sessions", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/financial_connections/sessions", "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

To launch the Financial Connections authorization flow, create a Session. The session’s client_secret can be used to launch the flow using Stripe.js.

" }, { "info": { "name": "Stripe Get Financial Connections Sessions Session", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/financial_connections/sessions/:session", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "session", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Retrieves the details of a Financial Connections Session

" }, { "info": { "name": "Stripe Get Identity Verification Sessions", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/identity/verification_sessions", "params": [ { "name": "created", "value": "", "type": "query" }, { "name": "ending_before", "value": "", "type": "query", "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list." }, { "name": "status", "value": "", "type": "query", "description": "Only return VerificationSessions with this status. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work)." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Returns a list of VerificationSessions

" }, { "info": { "name": "Stripe Post Identity Verification Sessions", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/identity/verification_sessions", "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Creates a VerificationSession object.

\n\n

After the VerificationSession is created, display a verification modal using the session client_secret or send your users to the session’s url.

\n\n

If your API key is in test mode, verification checks won’t actually process, though everything else will occur as if in live mode.

\n\n

Related guide: Verify your users’ identity documents

" }, { "info": { "name": "Stripe Get Identity Verification Sessions Session", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/identity/verification_sessions/:session", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "session", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Retrieves the details of a VerificationSession that was previously created.

\n\n

When the session status is requires_input, you can use this method to retrieve a valid\nclient_secret or url to allow re-submission.

" }, { "info": { "name": "Stripe Post Identity Verification Sessions Session", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/identity/verification_sessions/:session", "params": [ { "name": "session", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Updates a VerificationSession object.

\n\n

When the session status is requires_input, you can use this method to update the\nverification check and options.

" }, { "info": { "name": "Stripe Post Identity Verification Sessions Session Cancel", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/identity/verification_sessions/:session/cancel", "params": [ { "name": "session", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

A VerificationSession object can be canceled when it is in requires_input status.

\n\n

Once canceled, future submission attempts are disabled. This cannot be undone. Learn more.

" }, { "info": { "name": "Stripe Post Identity Verification Sessions Session Redact", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/identity/verification_sessions/:session/redact", "params": [ { "name": "session", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Redact a VerificationSession to remove all collected information from Stripe. This will redact\nthe VerificationSession and all objects related to it, including VerificationReports, Events,\nrequest logs, etc.

\n\n

A VerificationSession object can be redacted when it is in requires_input or verified\nstatus. Redacting a VerificationSession in requires_action\nstate will automatically cancel it.

\n\n

The re" }, { "info": { "name": "Stripe Post Link Account Sessions", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/link_account_sessions", "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

To launch the Financial Connections authorization flow, create a Session. The session’s client_secret can be used to launch the flow using Stripe.js.

" }, { "info": { "name": "Stripe Get Link Account Sessions Session", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/link_account_sessions/:session", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "session", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Retrieves the details of a Financial Connections Session

" } ] } ], "bundled": true }